แชร์ผ่าน

Admin - Get Activity Events

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

Returns a list of audit activity events for a tenant.

Provide either a continuation token or both a start and end date time. StartDateTime and EndDateTime must be in the same UTC day and should be wrapped in single quotes.

Permissions

  • The user must be a Fabric administrator or authenticate using a service principal.
  • Delegated permissions are supported.

When running under service prinicipal authentication, an app must not have any admin-consent required premissions for Power BI set on it in the Azure portal.

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All

Relevant only when authenticating via a standard delegated admin access token. Must not be present when authentication via a service principal is used.

Limitations

  • Maximum 200 requests per hour.
  • Activity logging isn't supported for Microsoft Cloud 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 Parameters

Name In Required Type Description
$filter
 query

string

Filters the results based on a boolean condition, using 'Activity', 'UserId', or both properties. Supports only 'eq' and 'and' operators.
continuationToken
 query

string

Token required to get the next chunk of the result set
endDateTime
 query

string

End date and time of the window for audit event results. Must be in ISO 8601 compliant UTC format.
startDateTime
 query

string

Start date and time of the window for audit event results. Must be in ISO 8601 compliant UTC format.

Responses

Name Type Description
200 OK

ActivityEventResponse

OK

Examples

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"
}

Definitions

ActivityEventResponse

OData response wrapper for audit activity events list

Name Type Description
activityEventEntities

object[]

An array of activity event objects. To learn more about an activity event (which is a collection of event properties) refer to Microsoft 365 Management Activity schema.
continuationToken

string

Token to get the next chunk of the result set
continuationUri

string

The URI for the next chunk in the result set