Skip to content

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

@rickyrick2002

Description

@rickyrick2002

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions