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

Any plan on providing some examples on "Common Endpoints" of the api document? #655

Open
rickyrick2002 opened this issue Jun 10, 2022 · 0 comments

Comments

@rickyrick2002
Copy link

rickyrick2002 commented Jun 10, 2022

This https://redash.io/help/user-guide/integrations-and-api/api web page, that is https://github.com/getredash/website/blob/master/src/pages/kb/user-guide/integrations-and-api/api.md has so little infomation on how to use the "Common Endpoints".

I have a csv file containing some query ids and need to use the api to set the schedule to null.

From the web page, I had no idea how I should post a request as for /api/queries/<id> and had no idea where to put the API key.

This (https://github.com/damienzeng73/redash-api-client) saves my day. But it's kinda upset that I can't get enough info from the official web page.

So I think you should probably improve this document. At least provide some simplest examples?

P.S. I've also looked through https://github.com/getredash/redash-toolbelt and the redash source code. Ya, someone might find useful information there but that really takes extra efforts.

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

No branches or pull requests

1 participant