topic Alteryx API - Run Length in Alteryx Server Discussions

Alteryx API - Run Length

matthewbechard — Wed, 04 Mar 2020 13:39:05 GMT

Hello-

Is there a "run length" field in the api or both a start_time and a end_time field that can be used to calculate "run length"?

Using the API endpoint /admin/v1/workflows/jobs/ , I only can seem to see createDate field. I am missing a field that would show the end time.

I am basically looking for this field shown below.

Any help would be appreciated.

Thanks,

Matt

Re: Alteryx API - Run Length

joshuaburkhow — Sun, 08 Mar 2020 13:00:58 GMT

There's nothing in that API endpoint that I know of. What I do is build a workflow that pulls this data from my MongoDB instances that way I can get exactly what I want. I also recommend implementing the "Alteryx Server Usage Report" if you haven't seen it yet as it has a lot of great detail on your workflows.

Re: Alteryx API - Run Length

MattH — Sun, 08 Mar 2020 20:20:50 GMT

Hi @matthewbechard,

@joshuaburkhow is correct. Currently the API does not report the completion time of a workflow run. Also, as mentioned above, this information can be pulled from your MongoDB instance, on the AlteryxService database and in the AS_Queue and AS_Results tables. To find workflows run through the API, you will need to filter on the IsHidden field (set it to filter on True) in the AS_Queue collection. Please note, if you have the functionality to allow users to run workflows without signing in, these will also be reported. If this is the case, you can also add a filter to match the username to the the SubscriptionID that houses the workflows.

Attached is a sample workflow I use to get Run and Queue times for workflows running through the Gallery that you can use. Just swap out the server name and passwords in the MongoDB Input tools

Re: Alteryx API - Run Length

matthewbechard — Mon, 09 Mar 2020 16:35:21 GMT

Thank you for your input!

Re: Alteryx API - Run Length

matthewbechard — Mon, 09 Mar 2020 16:37:50 GMT

Matt -Thank you for your input.... I wanted to accept this answer as the solution, but I click accept by accident on another answer. The mongo db flow gave me exactly what I was looking for.

Thanks again,

Matt

Re: Alteryx API - Run Length

bertal34 — Wed, 19 Jul 2023 21:04:12 GMT

@MattH

Hi Matt - in the Mongo data, how can you tell difference between a job that was run manually vs one that was truly scheduled?

Re: Alteryx API - Run Length

dheissner — Wed, 14 Feb 2024 20:14:45 GMT

Hi @MattH, The workflow you provided has a dependency on C:\Users\kcunningham\Documents\UsageReporting2\blobInput.yxdb

So it doesn't run. Any help on this?

Re: Alteryx API - Run Length

MattH — Wed, 14 Feb 2024 20:28:15 GMT

You've probably already found this, but one of the columns coming out of AS_Queue is AS_Schedules__ID. If a workflow is being run from a schedule, this column will be populated with the MongoDB _id of that schedule. If it is blank, then it is a manual Gallery run.

Re: Alteryx API - Run Length

MattH — Wed, 14 Feb 2024 20:57:00 GMT

Hi @dheissner, The C:\Users\kcunningham\Documents\UsageReporting2\blobInput.yxdb dependency can be ignored. The file was used to create the macro input schema for ServiceDataPaerser macro, which should persist without that file.

In our 2023.2 release of Alteryx Server, we removed the ServiceBlob from most of the MongoDB collections and directly output the contents to the collection. If you are running Server 2023.2, this could be the reason for an error in the workflow. You can simply delete the macro and connect around.

Re: Alteryx API - Run Length

MattH — Wed, 14 Feb 2024 21:09:35 GMT

Attached is an updated version for 2023.2 which no longer uses the macro. I've also set it to pull out all fields from the collections.