mirror of
https://github.com/MicrosoftDocs/windows-itpro-docs.git
synced 2025-06-07 01:57:21 +00:00
100 lines
2.7 KiB
Markdown
100 lines
2.7 KiB
Markdown
---
|
|
title: Get file statistics API
|
|
description: Retrieves the prevalence for the given file.
|
|
keywords: apis, graph api, supported apis, get, file, statistics
|
|
search.product: eADQiWindows 10XVcnh
|
|
ms.prod: w10
|
|
ms.mktglfcycl: deploy
|
|
ms.sitesec: library
|
|
ms.pagetype: security
|
|
ms.author: macapara
|
|
author: mjcaparas
|
|
ms.localizationpriority: medium
|
|
manager: dansimp
|
|
audience: ITPro
|
|
ms.collection: M365-security-compliance
|
|
ms.topic: article
|
|
---
|
|
|
|
# Get file statistics API
|
|
|
|
**Applies to:** [Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)](https://go.microsoft.com/fwlink/p/?linkid=2069559)
|
|
|
|
- Want to experience Microsoft Defender ATP? [Sign up for a free trial.](https://www.microsoft.com/microsoft-365/windows/microsoft-defender-atp?ocid=docs-wdatp-exposedapis-abovefoldlink)
|
|
|
|
|
|
## API description
|
|
Retrieves the statistics for the given file.
|
|
|
|
|
|
## Limitations
|
|
1. Rate limitations for this API are 100 calls per minute and 1500 calls per hour.
|
|
|
|
|
|
## Permissions
|
|
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Use Microsoft Defender ATP APIs](apis-intro.md)
|
|
|
|
Permission type | Permission | Permission display name
|
|
:---|:---|:---
|
|
Application | File.Read.All | 'Read file profiles'
|
|
Delegated (work or school account) | File.Read.All | 'Read file profiles'
|
|
|
|
>[!Note]
|
|
> When obtaining a token using user credentials:
|
|
>- The user needs to have at least the following role permission: 'View Data' (See [Create and manage roles](user-roles.md) for more information)
|
|
|
|
## HTTP request
|
|
```
|
|
GET /api/files/{id}/stats
|
|
```
|
|
|
|
## Request headers
|
|
|
|
Name | Type | Description
|
|
:---|:---|:---
|
|
Authorization | String | Bearer {token}. **Required**.
|
|
|
|
|
|
## Request body
|
|
Empty
|
|
|
|
## Response
|
|
If successful and file exists - 200 OK with statistical data in the body. If file do not exist - 404 Not Found.
|
|
|
|
|
|
## Example
|
|
|
|
**Request**
|
|
|
|
Here is an example of the request.
|
|
|
|
[!include[Improve request performance](../../includes/improve-request-performance.md)]
|
|
|
|
```
|
|
GET https://api.securitycenter.windows.com/api/files/0991a395da64e1c5fbe8732ed11e6be064081d9f/stats
|
|
```
|
|
|
|
**Response**
|
|
|
|
Here is an example of the response.
|
|
|
|
|
|
```
|
|
HTTP/1.1 200 OK
|
|
Content-type: application/json
|
|
{
|
|
"@odata.context": "https://api.securitycenter.windows.com/api/$metadata#microsoft.windowsDefenderATP.api.InOrgFileStats",
|
|
"sha1": "0991a395da64e1c5fbe8732ed11e6be064081d9f",
|
|
"orgPrevalence": "14850",
|
|
"orgFirstSeen": "2019-12-07T13:44:16Z",
|
|
"orgLastSeen": "2020-01-06T13:39:36Z",
|
|
"globalPrevalence": "705012",
|
|
"globalFirstObserved": "2015-03-19T12:20:07.3432441Z",
|
|
"globalLastObserved": "2020-01-06T13:39:36Z",
|
|
"topFileNames": [
|
|
"MREC.exe"
|
|
]
|
|
}
|
|
|
|
```
|