How to get detailed data of a workflow execution?

Kshitij_Bharde · January 20, 2020, 6:54am

Hi, I want to create a detailed report of workflow execution, for which I need detailed data of an execution. I would like to know how UI fetches all the data related to a particular execution Id and displays state of every node at the time execution.

jan · January 20, 2020, 2:01pm

To display past executions (at least the ones which got saved to the database) the UI uses the endpoint /rest/executions/:id
Be however aware that this is not an officially supported API and is currently only meant for the Editor-UI. Meaning that it may change in the future. So if you rely on it, make sure to check what got changed before you upgrade to a new n8n version. The code for that endpoint can be found here:

github.com

n8n-io/n8n/blob/master/packages/cli/src/Server.ts#L924

      
        
            			`/${this.restEndpoint}/workflows/new`,
            			ResponseHelper.send(async (req: WorkflowRequest.NewName) => {
            				const requestedName =
            					req.query.name && req.query.name !== '' ? req.query.name : this.defaultWorkflowName;
            
            
				return await GenericHelpers.generateUniqueName(requestedName, 'workflow');
            			}),
            		);
            
            
		// Returns a specific workflow
            		this.app.get(
            			`/${this.restEndpoint}/workflows/:id`,
            			ResponseHelper.send(async (req: WorkflowRequest.Get) => {
            				const { id: workflowId } = req.params;
            
            
				let relations = ['workflow', 'workflow.tags'];
            
            
				if (config.get('workflowTagsDisabled')) {
            					relations = relations.filter((relation) => relation !== 'workflow.tags');
            				}

The data of a currently running execution gets pushed to the Editor-UI via Server-Sent events. That happens via workflow hooks which get triggered at different points through the execution of the workflow. The code for that can be found here:

github.com

n8n-io/n8n/blob/master/packages/cli/src/WorkflowExecuteAdditionalData.ts#L114

      
        
            			},
            			workflow: {
            				id: workflowData.id !== undefined ? workflowData.id.toString() : undefined,
            				name: workflowData.name,
            			},
            		};
            
            
		// Run the error workflow
            		// To avoid an infinite loop do not run the error workflow again if the error-workflow itself failed and it is its own error-workflow.
            		if (
            			// eslint-disable-next-line @typescript-eslint/prefer-optional-chain
            			workflowData.settings !== undefined &&
            			workflowData.settings.errorWorkflow &&
            			!(
            				mode === 'error' &&
            				workflowData.id &&
            				workflowData.settings.errorWorkflow.toString() === workflowData.id.toString()
            			)
            		) {
            			Logger.verbose(`Start external error workflow`, {
            				executionId,

prononext · December 23, 2022, 12:06am

Made a feature request of it Execution Details in Text Format on n8n UI

BramKn · December 23, 2022, 8:07am

Hi @prononext

You don’t have to revive years old topics to tell others about your feature request

MutedJam · March 23, 2023, 8:08am

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.