taskReport: summary (of a lifecycle workflow)

Namespace: microsoft.graph.identityGovernance


APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get a taskReportSummary object.

This API provides a summary of task processing results for a specified time period. Because the volume of task processing results and task reports returned by the List API calls can be overwhelming, this summary allows the administrator to get a quick overview based on counts.


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All

For delegated scenarios, the admin needs one of the following Azure AD roles:

  • Global administrator
  • Global reader
  • Lifecycle workflows administrator

HTTP request

GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/taskReports/summary(startDateTime={timestamp},endDateTime={timestamp})

Function parameters

In the request URL, provide the following query parameters with values.

Parameter Type Description
startDateTime DateTimeOffset The start date and time of the period for which the taskReport summary will be generated.
endDateTime DateTimeOffset The end date and time of the period for which the taskReport summary will be generated.

Optional query parameters

This method supports the $count, $orderBy, $expand, and $filter OData query parameters to help customize the response. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.


If successful, this method returns a 200 OK response code and a microsoft.graph.identityGovernance.taskReportSummary object in the response body.



The following is an example of a request.

GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/taskReports/summary(startDateTime=2022-08-19T00:00:00.000Z,endDateTime=2022-08-25T00:33:31.533Z)


The following is an example of the response

HTTP/1.1 200 OK
Content-Type: application/json

    "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.identityGovernance.taskReportSummary",
    "successfulTasks": 8,
    "failedTasks": 0,
    "unprocessedTasks": 0,
    "totalTasks": 8