We've updated some of our product names. Nintex Analytics is now called Insights.

Nintex Insights OData API Reference

The Nintex Insights OData API uses the OData 4.0 protocol. For more information about the OData protocol, see OData.org and Oasis: OData Version 4.0 Protocol.

If you want to analyze your workflow data for specific insights, you can design your workflows using beacon actions in the following Nintex capabilities:

Note: Only GET requests are supported. You cannot POST data. You can use the Refresh option in the OData client application to view the latest data updates. The data is not refreshed in real-time and it can take up to three hours to fetch the updated details.

The following sections describe the available endpoints, properties, and JSON examples for the Nintex Insights OData API.

ProcessBeacons

The ProcessBeacons endpoint provides details for workflow actions that capture and emit process or stage specific data, such as the time an approval was requested or completed.

Available properties:

Property	Type	Nullable	Description
isolationid	String	false	Id for the connected Nintex capability tenant in Nintex Insights.
productId	String	false	Id for the connected Nintex capability in Nintex Insights.
workflowInstanceId	String	false	Unique id for the actual instance of the running workflow.
stageId	String		Id of the point/action in the workflow which is sending the beacon.
key	String		Name of a beacon to use for passing data from the workflow to Nintex Insights.
value	String		Value of the beacon.
beaconDateTime	DateTimeOffset		Date and time the beacon was run.

Example:

https://<Nintex Insights OData API URL>/ProcessBeacons

{
  "@odata.context": "https://na-odata.xyz.com/v1/odata/workflow/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/$metadata#ProcessBeacons",
  "value": [
    {
      "isolationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "productId": "nw4o365",
      "workflowInstanceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "key": "beacon",
      "value": "site",
      "beaconDateTime": "2018-05-02T00:45:03.620783Z"
    }
  ]
}

ProcessStages

The ProcessStages endpoint provides details for the defined stage in a workflow consisting of one or more actions. The event is processed when the stage starts and ends.

Available properties:

Property	Type	Nullable	Description
isolationid	String	false	Id for the connected Nintex capability tenant in Nintex Insights.
productId	String	false	Id for the connected Nintex capability in Nintex Insights.
workflowInstanceId	String	false	Unique id for the actual instance of the running workflow.
stageId	String	false	Id of the point/action in the workflow which is sending the beacon.
stageName	String		Name to identify a process stage within the workflow.
startDate	DateTimeOffset		Date and time the process stage was started.
endDate	DateTimeOffset		Date and time the process stage was completed.

Example:

https://<Nintex Insights OData API URL>/ProcessStages

{
    "@odata.context": "https://na-odata.xyz.com/v1/odata/workflow/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/$metadata#ProcessStages",
    "value": [
        {
            "isolationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "productId": "nw4o365",
            "workflowInstanceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "stageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "stageName": "Beacon_H03_e O365S_HE03_BeaconS_SendEmail_BeaconE_01",
            "startDate": "2018-04-23T00:31:13.648Z",
            "endDate": "2018-04-23T00:31:31.240234Z"
        },
        {
            "isolationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "productId": "nw4o365",
            "workflowInstanceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "stageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "stageName": "Beacon_H03_e O365S_HE03Site_BeaconS_SendEmail_BeaconE_01",
            "startDate": "2018-04-23T06:58:34.658405Z",
            "endDate": "2018-04-23T06:58:54.752825Z"
        },
        {
            "isolationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "productId": "nw4o365",
            "workflowInstanceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "stageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "stageName": "Beacon_H03_e O365S_HE03_BeaconS_SendEmail_BeaconE_01",
            "startDate": "2018-04-23T00:27:10.262205Z",
            "endDate": "2018-04-23T00:27:29.480421Z"
        },
        {
            "isolationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "productId": "nw4o365",
            "workflowInstanceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "stageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "stageName": "Beacon_H03_e O365S_HE03_BeaconS_SendEmail_BeaconE_01",
            "startDate": "2018-04-20T10:00:13.78068Z",
            "endDate": "2018-04-20T10:00:35.556983Z"
        }

]
}

WorkflowInstances

The WorkflowInstances endpoint provides a list of all workflow executions for the associated workflow. The workflow execution would typically be modelled to represent a business event, for example, an expense claim. A workflow instance is an execution of the sequence of actions described by a workflow, which includes and has a time of initiation, length of time logged messages, and other metrics.

Available properties:

Property	Type	Nullable	Description
isolationId	Guid	false	Id for the connected Nintex capability tenant in Nintex Insights.
workflowId	String	false	Id for the connected Nintex capability in Nintex Insights.
productId	String	false	Unique id for the actual instance of the running workflow.
workflowInstanceId	String	false	Id of the point/action in the workflow which is sending the beacon.
statusId	String		Current status of the workflow. Values are: Started Completed Terminated Failed Disabled
startDateTime	DateTimeOffset		Date and time the task was created.
endDateTime	DateTimeOffset		Date and time the instance stopped, if it has stopped.
initiatorDisplayName	String		Display name of the user who initiated the workflow instance.
initiatorLoginName	String		Login name of the user who initiated the workflow instance.
initiatorEmail	String		Email of the user who initiated the workflow instance.
duration	String		Duration for which the workflow instance was running.

Example:

https://<Nintex Insights OData API URL>/WorkflowInstances

{
    "@odata.context": "https://na-odata.xyz.com/v1/odata/workflow/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/$metadata#WorkflowInstances",
    "value": [
        {
            "isolationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "productId": "nw4o365",
            "workflowInstanceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "statusId": "Completed",
            "startDateTime": "2018-04-23T05:17:19.250885Z",
            "endDateTime": "2018-04-23T05:17:38.166628Z"
        },
        {
            "isolationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "productId": "nw4o365",
            "workflowInstanceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "statusId": "Completed",
            "startDateTime": "2018-04-23T06:36:08.697486Z",
            "endDateTime": "2018-04-23T06:38:24.146605Z"
        },
        {
            "isolationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "productId": "nw4o365",
            "workflowInstanceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "statusId": "Completed",
            "startDateTime": "2018-05-01T05:40:13.52671Z",
            "endDateTime": "2018-05-01T05:40:33.134019Z"
        },
        {
            "isolationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "productId": "nw4o365",
            "workflowInstanceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "statusId": "Completed",
            "startDateTime": "2018-04-23T00:34:03.83881Z",
            "endDateTime": "2018-04-23T00:34:21.414019Z"
        },
        {
            "isolationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "productId": "nw4o365",
            "workflowInstanceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "statusId": "Completed",
            "startDateTime": "2018-05-01T14:40:28.961205Z",
            "endDateTime": "2018-05-01T14:40:50.844358Z"
        }        
	]
}

Workflows

The Workflows endpoint provides additional metadata and Nintex-specific functionality, such as versioning, interactive development, and reporting. A workflow is a sequence of tasks that produces a result, such as the automated movement of documents or items through a sequence of actions or tasks that are related to a business process.

Available properties:

Property	Type	Nullable	Description
isolationId	String	false	Id for the connected Nintex capability in Nintex Insights.
workflowId	String	false	Unique id mapping the instance to the workflow.
productId	String	false	Unique id for the actual instance of the running workflow.
workflowName	String		Name of the workflow.
workflowVersion	String		Version number of the workflow.
workflowType	String		Type of workflow.
authorDisplayName	String		Display name of the user who created the workflow.
authorEmail	String		Email address of the user who created the workflow.
authorLoginName	String		Login name of the user who created the workflow.
entitlementType	String		Entitlement type of the workflow for consumption licences (“Production” or “Development”).
listId	String		Unique id of the list in SharePoint.
listName	String		Name of the SharePoint list.
listPath	String		Path of the SharePoint list.
listUri	String		Uniform Resource Identifier (URI) of the SharePoint list.
publishedDateTime	DateTimeOffset		Data and time when the workflow is published.
siteCollectionId	String		GUID of the SharePoint site collection.
siteId	String		A more specific location id within the environment.
sitePath	String		Path of the SharePoint site.
siteUri	String		URI of the SharePoint site.
locationName	String		Location of the SharePoint site.
billable	Boolean		Returns true if the workflow contains billable actions.
isDeleted	Boolean		Returns true if the workflow has been deleted.

Example:

https://<Nintex Insights OData API URL>/Workflows

{
  "@odata.context": "https://na-odata.xyz.com/v1/odata/workflow/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/$metadata#Workflows",
  "value": [
    {
      "isolationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "productId": "nw4o365",
      "workflowName": "Scheduled Workflow PDT Test 20181226044115429",
      "authorDisplayName": "Nintex SPSiteAdmin",
      "authorEmail": "test@test.com",
      "entitlementType": "Production",
      "publishedDateTime": "2018-12-25T17:41:54.349295Z",
      "siteCollectionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "siteId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "sitePath": "Test",
      "siteUri": "https://test.sharepoint.com/test",
      "isDeleted": false
    },
    {
      "isolationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "productId": "nw4o365",
      "workflowName": "Scheduled Workflow PDT Test 20181206182449235",
      "authorDisplayName": "Nintex SPSiteAdmin",
      "authorEmail": "test@test.com",
      "entitlementType": "Development",
      "publishedDateTime": "2018-12-06T07:25:23.219815Z",
      "siteCollectionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "siteId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "sitePath": "/PDT_Stabilize_v2.2.0",
      "siteUri": "https://test.sharepoint.com/test",
      "isDeleted": false
    },
    {
      "isolationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "workflowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "productId": "nw4o365",
      "workflowName": "TranslateV3AfterDeSideLoad - Test6",
      "authorDisplayName": "Nintex SPSiteAdmin",
      "authorEmail": "test@test.com",
      "entitlementType": "Development",
      "publishedDateTime": "2019-04-03T09:32:43.586246Z",
      "siteCollectionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "siteId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "sitePath": "test",
      "siteUri": "https://test.sharepoint.com/test",
      "isDeleted": false
    }
  ]
}