LoginSignup
8
5

More than 1 year has passed since last update.

Redash APIの要点、個人的まとめ

Last updated at Posted at 2021-12-10

APIキーの種類と取得方法

Redashには以下の2種類のAPIキーが存在する。

Query API Key

1つのクエリごとに1つのAPIキーが割り当てられている。
特に理由がなければ、このキーを使うことが推奨されている。
処理を作った人が退職したとしても、クエリが残っている限りAPIを叩き続けることができる。
73d76d2e-b88d-4558-bb65-cb4a7bf7b848-1920x292r.png
a89afb0b-3cc5-4166-bf4f-fec35d933a3a-1920x745r.png

User API Key

1ユーザーごとに1つのAPIキーが割り当てられている。
Refresh APIとか、一部のAPIはこのキーじゃないと叩けない
0ce7bde5-ab62-4166-8baf-ade5de3a2b06-1920x384r.png
e98e21da-b2cd-44f5-aeef-8c23cc5b89bd-1920x599r.png
6413ab0c-7f5b-4335-8d8f-5f56237973ee-1920x862r.png

よく使いそうなクエリ

特定のクエリの、最新の実行結果を取得

Redashに直近の実行結果がキャッシュされているので、その値を取得。
このAPIを叩くタイミングでクエリが走る訳ではない点に注意。

(GET) https://{YOUR_REDASH_HOST}/api/queries/{QUERY_ID}/results.json?api_key={ANY_API_KEY}

特定のクエリを実行して、結果を最新にする(Refresh API)

(POST) http://{YOUR_REDASH_HOST}/api/queries/{QUERY_ID}/refresh?api_key={USER_API_KEY}

クエリ中にパラメーターがある場合、p_{パラメーター名}={値}の形でセットする

...?api_key={USER_API_KEY}&p_user_id=12345&p_limit=10

参考

https://redash.io/help/user-guide/integrations-and-api/api
https://qiita.com/meteoride/items/d6c11e2a96537bbb9dc3

8
5
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
8
5