insights: topWorkflowsProcessedSummary

Article
08/20/2024

Namespace: microsoft.graph.identityGovernance

Important

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.

Provide a summary of the workflows processed the most, known as top workflows, for a specified period in a tenant. Workflow basic details are given, along with run information. For information about tasks processed, see insights: topTasksProcessedSummary.

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/topWorkflowsProcessedSummary(startDateTime={startDateTime},endDateTime={endDateTime})

Function parameters

In the request URL, provide the following query parameters with values. The following table lists the parameters that are required when you call this function.

Parameter	Type	Description
startDateTime	DateTimeOffset	The start date, and time, of the summary of the most workflows processed in a tenant.
endDateTime	DateTimeOffset	The end date, and time, of the summary of the most workflows processed 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 microsoft.graph.identityGovernance.topWorkflowsInsightsSummary collection in the response body.

Examples

Request

The following example shows a request.

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


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.IdentityGovernance.LifecycleWorkflows.Insights.MicrosoftGraphIdentityGovernanceTopWorkflowsProcessedSummaryWithStartDateTimeWithEndDateTime(DateTimeOffset.Parse("{endDateTime}"),DateTimeOffset.Parse("{startDateTime}")).GetAsTopWorkflowsProcessedSummaryWithStartDateTimeWithEndDateTimeGetResponseAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



mgc-beta identity-governance lifecycle-workflows insights microsoft-graph-identity-governance-top-workflows-processed-summary-with-start-date-time-with-end-date-time get --start-date-time {start-date-time-id} --end-date-time {end-date-time-id}

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
startDateTime , err := time.Parse(time.RFC3339, "{startDateTime}")
endDateTime , err := time.Parse(time.RFC3339, "{endDateTime}")
microsoftGraphIdentityGovernanceTopWorkflowsProcessedSummary, err := graphClient.IdentityGovernance().LifecycleWorkflows().Insights().MicrosoftGraphIdentityGovernanceTopWorkflowsProcessedSummaryWithStartDateTimeWithEndDateTime(&startDateTime, &endDateTime).GetAsTopWorkflowsProcessedSummaryWithStartDateTimeWithEndDateTimeGetResponse(context.Background(), nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.identityGovernance().lifecycleWorkflows().insights().microsoftGraphIdentityGovernanceTopWorkflowsProcessedSummaryWithStartDateTimeWithEndDateTime(OffsetDateTime.parse("{endDateTime}"), OffsetDateTime.parse("{startDateTime}")).get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let topWorkflowsProcessedSummary = await client.api('/identityGovernance/lifecycleWorkflows/insights/topWorkflowsProcessedSummary(startDateTime=2023-01-01T00:00:00Z,endDateTime=2023-01-31T00:00:00Z)')
	.version('beta')
	.get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->identityGovernance()->lifecycleWorkflows()->insights()->microsoftGraphIdentityGovernanceTopWorkflowsProcessedSummaryWithStartDateTimeWithEndDateTime(new \DateTime('{endDateTime}'),new \DateTime('{startDateTime}'))->get()->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Beta.Identity.Governance

Invoke-MgBetaTopIdentityGovernanceLifecycleWorkflowInsightWorkflowProcessedSummary

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.identity_governance.lifecycle_workflows.insights.microsoft_graph_identity_governance_top_workflows_processed_summary_with_start_date_time_with_end_date_time("{endDateTime}","{startDateTime}").get()

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

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

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.identityGovernance.topWorkflowsInsightsSummary)",
 "value": [
   { 
      "workflowId" : "6a98cceb-503b-709c-996c-3cg0f24481eb", 
      "workflowDisplayName" : "Pre-hire workflow", 
      "workflowCategory" : "Joiner", 
      "totalRuns" : 30 , 
      "successfulRuns" : 28 ,
      "failedRuns" : 2 , 
      "scheduledRuns" : 26, 
      "onDemandRuns" : 4, 
      "totalUsers" : 45, 
      "successfulUsers" : 38, 
      "failedUsers": 7,
      "workflowVersion" : 3 
   }, 
   { 
      "workflowId" : "8b67ddeb-603b-609c-293f-4dg0f28481ek", 
      "workflowDisplayName" : "Pre-Hire workflow", 
      "workflowCategory" : "Joiner", 
      "totalRuns" : 35 ,
      "successfulRuns" : 26 ,
      "failedUsers" : 9, 
      "scheduledRuns" : 30, 
      "onDemandRuns" : 5,  
      "totalUsers" : 56, 
      "successfulUsers" : 47 , 
      "failedUsers": 9,
      "workflowVersion" : 1  
   }, 
   { 
      "workflowId" : "1f67cceb-203b-909c-096f-6cg0f28481fg", 
      "workflowDisplayName" : "Post-Hire Workflow", 
      "workflowCategory" : "Jeaver", 
      "totalRuns" : 32  ,
      "successfulRuns" : 25 ,
      "failedRuns" : 7 , 
      "scheduldedRuns" : 15, 
      "onDemandRuns" :  17, 
      "totalUsers": 53, 
      "successfulUsers" : 45, 
      "failedUsers" : 8,
      "workflowVersion" : 2 
   }, 
   { 
      "workflowId" : "2s67ddeb-303b-709c-896f-4cg0f28481ed", 
      "workflowDisplayName" : "Pre-Hire Workflow", 
      "workflowCategory" :"Joiner" , 
      "totalRuns" : 28 ,
      "successfulRuns" : 23, 
      "failedRuns" : 5, 
      "scheduldedRuns" : 20, 
      "onDemandRuns" : 8, 
      "totalUsers" : 40, 
      "successfulUsers" : 32 , 
      "failedUsers" : 8,
      "workflowVersion" : 2  
   }, 
   { 
      "workflowId" : "7a67ddeb-503b-909d-995f-3cg0f26481eh", 
      "workflowDisplayName" : "Post-Hire Workflow", 
      "workflowCategory" : "Leaver", 
      "totalRuns" : 26 ,
      "successfulRuns" : 20 , 
      "failedRuns" : 6 , 
      "scheduldedRuns" : 12, 
      "onDemandRuns" : 14, 
      "totalUsers" : 34, 
      "successfulUsers" : 23, 
      "failedUsers" : 11,
      "workflowVersion" : 1 
   }, 
  ] 
}

Share via

insights: topWorkflowsProcessedSummary

Permissions

HTTP request

Function parameters

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources