Using Oomnitza’s monitoring and logging APIs

Whether you're trying to debug a workflow run or simply track the progress of your automation, Oomnitza's monitoring and logging APIs can help you get the information you need.

Activities API

The Activities API provides an overview of user activities in Oomnitza. 

Refer to the Swagger documentation in Configuration>Integrations>Rest APIs (Swagger Docs) for further details.

Connector API

The Connector Run Logs API provides a summary of each integration run including the number of updates, errors, added objects, and skipped objects.

You'll need to supply the ID of your integration to run the API.  To locate the ID of your integration, go to Configuration> Integrations>Overview and select your integration from the list. The integration ID is displayed on the Info page. It is also displayed in the URL  https://demo.oomnitza.com/settings/connectors?id=4

Refer to the Swagger documentation in Configuration>Integrations>Rest APIs (Swagger Docs) for further information.

Tip 
You can use the portion_id returned in the response to use the Get Connector Portion ID API, and get a more detailed view of each integration run, including specific details on each error.

Workflows API

You can use the Workflows API to get an overview of workflow runs, including workflow errors, using the workflow ID. To find your workflow ID, navigate to your workflow in Oomnitza. The id is displayed in the URL  https://demo.oomnitza.com/users/workflow/view_workflow?id=*****************

Run the following API query in Postmanhttps://{subdomain}.oomnitza.com/api/v3/users/workflows/{workflow_external_id}/processes. You will need to replace /{workflow_external_id}in the URL with the actual workflow ID that you obtained in the previous step. 

The following is an example of the Workflows API response:

      {
        "run_id": 1234567,
        "wf_external_id": "**************", 
        "wf_id": 123,
        "wf_name": "Lazy Loading",
        "object": "USERS",
        "object_id": "qa3-OM",
        "status": 5,
        "start_date": 1653397450,
        "end_date": 1653397520,
        "initiator": "Nobody",
        "nodes_runs_logs_count": 0,
        "nodes_runs_logs": {},
        "version": 4
    },
  

Additional Documentation