Table of Contents

Retrieve Unusual Activities

Get the basic information of unusual activities (/backup/m365/cloudbackupunusualactivitydata navigation property) detected by Cloud Backup for Microsoft 365. By invoking the /backup/m365/cloudbackupunusualactivitydata endpoint, users can gain the number of sites with unusual activities and that are under potential ransomware attacks in your tenant.

Permission

The following permission is required to call this API.
You must register an app through AvePoint Online Services > App registration to authenticate and authorize your access to AvePoint Graph API. For details, refer to Authentication and Authorization.

API Permission
/backup/m365/cloudbackupunusualactivitydata microsoft365backup.unusualActivity.read.all

Request

This section outlines the HTTP method and endpoint used to retrieve the basic information of unusual activities. It provides a concise description of the action performed by the API call.

Method Endpoint Description
GET /backup/m365/cloudbackupunusualactivitydata Gets the basic information of unusual activities detected by Cloud Backup for Microsoft 365.

Query Parameters

The API supports several query parameters to refine and customize the data retrieval process. These parameters allow uses to specify the detected time range and location to filter the results effectively.

Parameter Description Type Required?
startTime Sets a start time (UTC time) for the detected time range. For example, 2024-01-01. string Yes
finishTime Sets a end time (UTC time) for the detected time range. For example, 2024-12-01. string Yes
location Available only for Multi-Geo tenants. If not specified, unusual activities are retrieved from all locations in your tenant. For supported values, refer to Parameter: location. string No

Responses

The API response provides the basic information of unusual activities. Each job in the response includes various attributes that describe its properties and status.

Retrieved result:

Elements Description Type
statusCode Http Response Status Code integer
message error message string
errors API error ApiError
data Basic information of unusual activities unusualactivitydata
requestId API Request ID string
timestamp API request time string
traceId API Trace ID string

Basic information of unusual activities

Elements Description Type
tenantOwner Tenant owner string
tenantId Tenant ID string
serviceType Service type. For valid values, refer to Attribute: serviceType. integer
potentialRansomwareAttackCount Number of sites with unusual activities long
unusualActivitiesCount Number of sites under potential ransomware attacks long

Request Sample

To use this API, send a GET request to the specified endpoint, including necessary parameters as defined in the references. This will return the basic information of unusual activities in a structured format, enabling easy integration with other systems or applications. The following request is an API call to the Cloud Backup for Microsoft 365 environment in the US - East region.

https://graph-us.avepointonlineservices.com/backup/m365/cloudbackupunusualactivitydata?StartTime=2024-01-01&FinishTime=2024-12-30&Location=NAM

Response Sample

If successful, this method returns a 200 OK response code and the basic information of unusual activities in the response body.
For details on the HTTP status code, refer to HttpStatusCode.

{
    "statusCode": 200, //Http Response Status Code
    "message": "", //Error message
    "data": {
        "data": [
                    {
                      "tenantOwner": "John Doe", //Tenant owner
                      "tenantId": "12345678-1234-1234-1234-123456789012", //Tenant ID
                      "serviceType": 1, //Service type
                      "potentialRansomwareAttackCount": 5, //Number of sites with unusual activities
                      "unusualActivitiesCount": 10, //Number of sites under potential ransomware attacks
                    }
                  ]
    },
    "requestId": "0HNEVHLNSPSEJ:00000004", //API Request ID
    "timestamp": "2025-08-20T03:45:46.3561083Z",  //API request time
    "traceId": "00-670aa1d01485c1a7bbcc88bd48b05ed7-ecfba726763bda2a-00" //API Trace ID
}