OrkestraOnline / Orkestra_Online

Orkestra Online is a cloud based platform for deploying, documenting and securing DynamoBIM and Grasshopper content.
https://www.orkestra.online
40 stars 2 forks source link

Direct access to analytics data #75

Closed Dre-Tas closed 3 years ago

Dre-Tas commented 3 years ago

It would be great to have direct access to the analytics data instead of only seeing it from the Analytics page in Orkestra.

In that way we'd be able to gather the insights that are important to us, filter things and combine the data with other (e.g. Active Directory)

tgossa commented 3 years ago

Hello @Dre-Tas,

Orkestra already lets you export your analytics data to csv! I think that's what you're looking for.

Orkestra_Analytics

Here's the link to the wiki: https://datashapes.gitbook.io/orkestra-online/orkestra-desktop-app/analytics#export-options

Dre-Tas commented 3 years ago

Yeah I know you can export the csv, but I'm thinking of directly accessing the actual database without having to export the csv every time I want to refresh the data (which would happen at least once every day).

MostafaElAyoubi commented 3 years ago

Hey @Dre-Tas ! there are plans for a REST API to get usage information through web requests. Basically you'll be sending requests with a json containing : login, password, hub (or all), workspace (or all), timeperiod (or all) and that will return the information from the Data Base. One of the things that are still unclear is how to return that information. For the moment, the tests being run return a formatted string that you then need to save as csv. Would that fulfill the need? Or do you have another workflow in mind?

Dre-Tas commented 3 years ago

Yeah I guess that would work too.

What I was thinking of was something as easy as getting a connection string to get Power BI (or tableau or whatever) to connect to the db and build your dashboards with it. Not sure how that would work under the hood.

Just as an example, I'm a big fan of pyrevit's telemetry. You have to set it up yourself and it writes to a db that you have to set up for yourself, but then it's your db and you can use it as you wish. Just another option to think about I guess ;)

MostafaElAyoubi commented 3 years ago

Thank you for that example, I'll definitely take a good look at it. This type of feature will most likely be deployed (in beta) within a couple of months .

MostafaElAyoubi commented 3 years ago

Implemented in v.1.2.0

parkerjgit commented 3 years ago

HI, any documentation available for the web API?

MostafaElAyoubi commented 3 years ago

Hi @parkerjgit ! Here you go 😄