Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API documentation difficult to find and understand #9033

Open
BRZangado opened this issue Nov 28, 2018 · 3 comments
Open

API documentation difficult to find and understand #9033

BRZangado opened this issue Nov 28, 2018 · 3 comments

Comments

@BRZangado
Copy link

BRZangado commented Nov 28, 2018

Hello! My name is Bruno and in the past few months I worked in a Games BI plataform. In the project, we needed something like Metabase to help in our app development, to help generate some graphics and stuff. Our first choice was Metabase, as we saw a huge potencial, nice looking graphics and a lot of things that could benifit our project, and in order to do this, we had to use the Metabase API, but.....

Difficult to find

We took a long time to find all the location of the API references. One ideia is to to put all the references into the metabase documentation at www.metabase.com/docs/latest/, in the "developer" section for example

Difficult to understand

The API documentation really does not say enought. How can we use that endpoint, example of a post request, what it will return? In other side, post requests requiring MBQL could be more intuitive.. side by side, you know? Maybe some examples would do the trick

I think if the API documentation were more intuitive and complete, Metabase could be one of the greatests business intelligence platform

⬇️ Please click the 👍 reaction instead of leaving a +1 or update? comment

@BRZangado

This comment was marked as resolved.

@jeff-bruemmer
Copy link
Member

jeff-bruemmer commented Dec 22, 2020

We now have a Learn article that covers an introduction to the API.

https://www.metabase.com/learn/developing-applications/advanced-metabase/metabase-api.html

@Timelessprod
Copy link

Any update on this topic ? Any ETA ? Thanks !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants