insights: workflowsProcessedByCategory

Namespace: microsoft.graph.identityGovernance

Provide a summary of workflows processed, by category, in a tenant. This allows you to quickly get category information, by numerical value, bypassing other information found in the WorkflowsProcessedSummary call.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permission Higher privileged permissions
Delegated (work or school account) Not supported. Not supported.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Not supported. Not supported.

Important

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. Global Reader and Lifecycle Workflows Administrator are the least privileged roles supported for this operation.

HTTP request

GET /identityGovernance/lifecycleWorkflows/insights/workflowsProcessedByCategory(startDateTime={startDateTime},endDateTime={endDateTime})

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 insight summary for workflows processed by category in a tenant.
endDateTime DateTimeOffset The end date, and time, of the insight summary for workflows processed by category in a tenant.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this function returns a 200 OK response code and a workflowsInsightsByCategory in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/insights/workflowsProcessedByCategory(startDateTime=2023-01-01T00:00:00Z,endDateTime=2023-01-31T00:00:00Z)

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

{
    "totalJoinerRuns" : 136, 
    "successfulJoinerRuns" : 112, 
    "failedJoinerRuns" : 24,  
    "totalMoverRuns" : 97, 
    "successfulMoverRuns" : 79, 
    "failedMoverRuns" : 18, 
    "totalLeaverRuns" : 103, 
    "successfulLeaverRuns" : 96, 
    "failedLeaverRuns" : 7,       
}