通过

Admin - Get Activity Events

  • 参考
Service:
Power BI REST APIs
API Version:
v1.0

返回租户的审核活动事件列表。

提供继续标记或同时提供开始和结束日期时间。 StartDateTime 和 EndDateTime 必须在同一 UTC 日，并且应用单引号括起来。

权限

  • 用户必须具有管理员权限 (，例如Office 365全局管理员或 Power BI 服务管理员) 或使用服务主体进行身份验证。
  • 支持委派权限。

在服务主身份验证下运行时，应用不得在Azure 门户中设置任何管理员同意所需的 Power BI 授权。

所需范围

Tenant.Read.All 或 Tenant.ReadWrite.All

仅当通过标准委派的管理员访问令牌进行身份验证时才相关。 使用通过服务主体进行身份验证时，不得存在。

限制

  • 每小时最多 200 个请求。
  • Microsoft 云 Deutschland 不支持活动日志记录。 

GET https://api.powerbi.com/v1.0/myorg/admin/activityevents
With optional parameters: 
GET 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”运算符。
continuationToken
 query

string

获取结果集的下一个区块所需的令牌
endDateTime
 query

string

审核事件结果窗口的结束日期和时间。 必须采用符合 ISO 8601 的 UTC 格式。
startDateTime
 query

string

审核事件结果窗口的开始日期和时间。 必须采用符合 ISO 8601 的 UTC 格式。

响应

名称 类型 说明
200 OK

ActivityEventResponse

确定

示例

Get audit activity events within a time window and for a specific activity type and user ID example
Get audit activity events within a time window and for a specific activity type example
Get audit activity events within a time window and for a specific user ID example
Get audit activity events within a time window example
Get the next set of audit activity events by sending the continuation token to the API example

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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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

Status code:
200 
{
  "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%3D

Sample Response

Status code:
200 
{
  "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