Admin - Get Activity Events
Возвращает список событий действий аудита для клиента.
Укажите маркер продолжения или дату и время окончания. StartDateTime Значение и EndDateTime должно находиться в одном и том же формате UTC и быть заключено в одинарные кавычки.
Разрешения
- Пользователь должен иметь права администратора (например, Office 365 глобального администратора или администратора службы Power BI) или пройти проверку подлинности с помощью субъекта-службы.
- Поддерживаются делегированные разрешения.
При выполнении в режиме предварительной проверки подлинности службы в портал Azure приложение не должно иметь необходимых предустановок согласия администратора для Power BI.
Требуемая область
Tenant.Read.All или Tenant.ReadWrite.All
Применимо только при проверке подлинности с помощью стандартного маркера доступа делегированного администратора. Не должно присутствовать при использовании проверки подлинности через субъект-службу.
Ограничения
- Максимум 200 запросов в час.
- Ведение журнала действий не поддерживается для Microsoft Cloud Deutschland.
GET https://api.powerbi.com/v1.0/myorg/admin/activityeventsGET https://api.powerbi.com/v1.0/myorg/admin/activityevents?startDateTime={startDateTime}&endDateTime={endDateTime}&continuationToken={continuationToken}&$filter={$filter}Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
$filter
|
query |
string |
Фильтрует результаты по логическому условию с помощью свойств Activity, UserId или обоих свойств. Поддерживает только операторы eq и and. |
|
|
continuation
|
query |
string |
Маркер, необходимый для получения следующего блока результирующих наборов |
|
|
end
|
query |
string |
Дата и время окончания окна для результатов события аудита. Должен быть в формате UTC, совместимом с ISO 8601. |
|
|
start
|
query |
string |
Дата и время начала окна для результатов события аудита. Должен быть в формате UTC, совместимом с ISO 8601. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
ОК |
Примеры
Get audit activity events within a time window and for a specific activity type and user ID example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/activityevents?startDateTime='2019-08-13T07:55:00.000Z'&endDateTime='2019-08-13T08:55:00.000Z'&$filter=Activity eq 'viewreport' and UserId eq 'john@contoso.com'Sample Response
{
"activityEventEntities": [
{
"Id": "8fb974dc-739e-41e4-a219-b5801e28095e",
"RecordType": 20,
"CreationTime": "2023-05-23T08:06:47",
"Operation": "GetSnapshots",
"OrganizationId": "98c45f19-7cac-4002-8702-97d943a5ccb4",
"UserType": 0,
"UserKey": "10033FFF8929F27A",
"Workload": "PowerBI",
"UserId": "abc@contoso.onmicrosoft.com",
"ClientIP": "185.175.34.186",
"UserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36 Edg/113.0.1774.50",
"Activity": "GetSnapshots",
"IsSuccess": true,
"RequestId": "ee4b5af1-9aa3-34fe-a163-7b188e865ef1",
"ActivityId": "cc1db5c9-ca04-484e-a6f2-f21de20bc000",
"ModelsSnapshots": []
},
{
"Id": "1db4c464-3e5d-4a89-b412-c2ce6fbae88e",
"CreationTime": "2023-05-23T08:43:34",
"Operation": "ViewReport",
"ClientIP": "122.172.83.253",
"Activity": "ViewReport",
"ItemName": "Capacity Metrics Analysis",
"WorkSpaceName": "Premium Capacity Utilization And Metrics 5/19/2023 11:57:07 AM",
"DatasetName": "Capacity Metrics Analysis",
"ReportName": "Capacity Metrics Analysis",
"CapacityId": "zy5bad4z-x1a2-491a-9f0c-f012171ee02e",
"CapacityName": "Shared On Premium - Reserved",
"WorkspaceId": "bf10ae91-c4f6-494e-b538-e2454229a765",
"AppName": "Premium Capacity Utilization And Metrics",
"ObjectId": "fb8a915c-b720-4a77-9e55-3a12fc42efcd",
"DatasetId": "5760cb34-a245-4eb7-a4e3-4ecae264a577",
"ReportId": "ae596344-7fe6-43cb-baa7-c7ddc63271c8",
"ArtifactId": "ae596344-7fe6-43cb-baa7-c7ddc63271c8",
"ArtifactName": "Capacity Metrics Analysis",
"ReportType": "PowerBIReport",
"RequestId": "9b8a4e32-b0c8-febf-c3c3-f25d45f682a4",
"ActivityId": "67c2dd35-242a-7053-4e92-8a7d78db9704",
"AppReportId": "3f87e0bd-a95d-40a4-bab5-5e206d643f8f",
"DistributionMethod": "Apps",
"ConsumptionMethod": "Power BI Web",
"ArtifactKind": "Report"
}
],
"continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/activityevents?continuationToken='%2BRID%3A244SAKlHY7YQAAAAAAAAAA%3D%3D%23RT%3A1%23TRC%3A5%23FPC%3AARAAAAAAAAAAFwAAAAAAAAA%3D'&$filter=Activity eq 'ViewReport'",
"continuationToken": "%2BRID%3A244SAKlHY7YQAAAAAAAAAA%3D%3D%23RT%3A1%23TRC%3A5%23FPC%3AARAAAAAAAAAAFwAAAAAAAAA%3D"
}Get audit activity events within a time window and for a specific activity type example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/activityevents?startDateTime='2019-08-13T07:55:00.000Z'&endDateTime='2019-08-13T08:55:00.000Z'&$filter=Activity eq 'ViewReport'Sample Response
{
"activityEventEntities": [
{
"Id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"CreationTime": "2019-08-13T07:55:15",
"Operation": "ViewReport",
"OrganizationId": "e43e3248-3d83-44aa-a94d-c836bd7f9b79",
"UserKey": "123456",
"Activity": "ViewReport",
"Workload": "PowerBI",
"UserId": "john@contoso.com",
"ClientIP": "127.0.0.1"
},
{
"Id": "c632aa64-70fc-4e80-88f3-9fc2cdcacce8",
"CreationTime": "2019-08-13T07:55:10",
"Operation": "ViewReport",
"OrganizationId": "e43e3248-3d83-44aa-a94d-c836bd7f9b79",
"UserKey": "42343KJK53K45J",
"Activity": "ViewReport",
"Workload": "PowerBI",
"UserId": "john@contoso.com",
"ClientIP": "131.107.160.240",
"CapacityId": "zy5bad4z-x1a2-491a-9f0c-f012171ee02e",
"CapacityName": "Shared On Premium - Reserved",
"WorkspaceId": "bf10ae91-c4f6-494e-b538-e2454229a765"
}
],
"continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/activityevents?continuationToken='%2BRID%3A244SAKlHY7YQAAAAAAAAAA%3D%3D%23RT%3A1%23TRC%3A5%23FPC%3AARAAAAAAAAAAFwAAAAAAAAA%3D'&$filter=Activity eq 'ViewReport'",
"continuationToken": "%2BRID%3A244SAKlHY7YQAAAAAAAAAA%3D%3D%23RT%3A1%23TRC%3A5%23FPC%3AARAAAAAAAAAAFwAAAAAAAAA%3D"
}Get audit activity events within a time window and for a specific user ID example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/activityevents?startDateTime='2019-08-13T07:55:00.000Z'&endDateTime='2019-08-13T08:55:00.000Z'&$filter=UserId eq 'john@contoso.com'Sample Response
{
"activityEventEntities": [
{
"Id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"CreationTime": "2019-08-13T07:55:15",
"Operation": "ViewReport",
"OrganizationId": "e43e3248-3d83-44aa-a94d-c836bd7f9b79",
"UserKey": "123456",
"Activity": "ViewReport",
"Workload": "PowerBI",
"UserId": "john@contoso.com",
"ClientIP": "127.0.0.1"
},
{
"Id": "c632aa64-70fc-4e80-88f3-9fc2cdcacce8",
"CreationTime": "2019-08-13T07:55:10",
"Operation": "ViewReport",
"OrganizationId": "e43e3248-3d83-44aa-a94d-c836bd7f9b79",
"UserKey": "42343KJK53K45J",
"Activity": "ViewReport",
"Workload": "PowerBI",
"UserId": "john@contoso.com",
"ClientIP": "131.107.160.240",
"CapacityId": "zy5bad4z-x1a2-491a-9f0c-f012171ee02e",
"CapacityName": "Shared On Premium - Reserved",
"WorkspaceId": "bf10ae91-c4f6-494e-b538-e2454229a765"
}
],
"continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/activityevents?continuationToken='%2BRID%3A244SAKlHY7YQAAAAAAAAAA%3D%3D%23RT%3A1%23TRC%3A5%23FPC%3AARAAAAAAAAAAFwAAAAAAAAA%3D'&$filter=Activity eq 'ViewReport'",
"continuationToken": "%2BRID%3A244SAKlHY7YQAAAAAAAAAA%3D%3D%23RT%3A1%23TRC%3A5%23FPC%3AARAAAAAAAAAAFwAAAAAAAAA%3D"
}Get audit activity events within a time window example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/activityevents?startDateTime='2019-08-13T07:55:00.000Z'&endDateTime='2019-08-13T08:55:00.000Z'Sample Response
{
"activityEventEntities": [
{
"Id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"CreationTime": "2019-08-13T07:55:15",
"Operation": "ViewReport",
"OrganizationId": "e43e3248-3d83-44aa-a94d-c836bd7f9b79",
"UserKey": "779438769",
"Activity": "ViewReport",
"Workload": "PowerBI",
"UserId": "john@contoso.com",
"ClientIP": "127.0.0.1"
},
{
"Id": "c632aa64-70fc-4e80-88f3-9fc2cdcacce8",
"CreationTime": "2019-08-13T07:55:10",
"Operation": "ViewDashboard",
"OrganizationId": "e43e3248-3d83-44aa-a94d-c836bd7f9b79",
"UserKey": "321HK34324",
"Activity": "ViewDashboard",
"Workload": "PowerBI",
"UserId": "john@contoso.com",
"ClientIP": "131.107.160.240",
"CapacityId": "zy5bad4z-x1a2-491a-9f0c-f012171ee02e",
"CapacityName": "Shared On Premium - Reserved",
"WorkspaceId": "bf10ae91-c4f6-494e-b538-e2454229a765"
}
],
"continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/activityevents?continuationToken='%2BRID%3A244SAKlHY7YGAAAAAAAAAA%3D%3D%23RT%3A1%23TRC%3A5%23FPC%3AAQYAAAAAAAAAFwAAAAAAAAA%3D'",
"continuationToken": "%2BRID%3A244SAKlHY7YGAAAAAAAAAA%3D%3D%23RT%3A1%23TRC%3A5%23FPC%3AAQYAAAAAAAAAFwAAAAAAAAA%3D"
}Get the next set of audit activity events by sending the continuation token to the API example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/activityevents?continuationToken=%2BRID%3A244SAKlHY7YQAAAAAAAAAA%3D%3D%23RT%3A1%23TRC%3A5%23FPC%3AARAAAAAAAAAAFwAAAAAAAAA%3DSample Response
{
"activityEventEntities": [
{
"Id": "91ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"CreationTime": "2019-08-13T08:55:15",
"Operation": "ViewReport",
"OrganizationId": "d43e3248-3d83-44aa-a94d-c836bd7f9b79",
"UserKey": "1236",
"Activity": "ViewReport",
"Workload": "PowerBI",
"UserId": "john@contoso.com",
"ClientIP": "127.0.0.1"
},
{
"Id": "g632bb64-70fc-4e80-88f3-9fc2cdcacce8",
"CreationTime": "2019-08-13T09:55:10",
"Operation": "ViewReport",
"OrganizationId": "e43e3248-3d83-44aa-a94d-c836bd7f9b79",
"UserKey": "42343KJK55J",
"Activity": "ViewReport",
"Workload": "PowerBI",
"UserId": "john@contoso.com",
"ClientIP": "131.107.160.240",
"CapacityId": "zy5bad4z-x1a2-491a-9f0c-f012171ee02e",
"CapacityName": "Shared On Premium - Reserved",
"WorkspaceId": "bf10ae91-c4f6-494e-b538-e2454229a765"
}
],
"continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/activityevents?continuationToken='%2BRID%$4Z244SAKlHY7YQAAAAAAAAAA%3D%3D%23RT%3A1%23TRC%3A5%23FPC%3AARAAAAAAAAAAFwAAAAAAAAA%3D'",
"continuationToken": "%2BRID%$4Z244SAKlHY7YQAAAAAAAAAA%3D%3D%23RT%3A1%23TRC%3A5%23FPC%3AARAAAAAAAAAAFwAAAAAAAAA%3D"
}Определения
ActivityEventResponse
Оболочка ответа OData для списка событий действий аудита
| Имя | Тип | Описание |
|---|---|---|
| activityEventEntities |
object[] |
Массив объектов событий действия. Дополнительные сведения о событии действия (который представляет собой коллекцию свойств события) см. в схеме действия управления Microsoft 365. |
| continuationToken |
string |
Маркер для получения следующего блока результирующих наборов |
| continuationUri |
string |
Универсальный код ресурса (URI) для следующего блока в результирующем наборе |