Get Notes
コミュニティノートのデータを取得するエンドポイント
Request
- Base URL: https://dev.api-birdxplorer.code4japan.org (the document declares no server; this is the origin it was published from)
- URL: https://dev.api-birdxplorer.code4japan.org/api/v1/data/notes
- Auth: none declared
Query parameters
データを取得する X のコミュニティノートの ID。
複数回クエリパラメータを指定する / カンマ区切りで複数の ID を指定することで複数のコミュニティノートを一括で取得できる。
取得するコミュニティノートの作成日時の下限。指定した日時と同時かそれより新しいコミュニティノートのみを取得する。
指定する形式は UNIX EPOCH TIME (ミリ秒) 。
取得するコミュニティノートの作成日時の上限。指定した日時よりも古いコミュニティノートのみを取得する。
指定する形式は UNIX EPOCH TIME (ミリ秒) 。
取得するコミュニティノートのリストの先頭からのオフセット。ページネーションに利用される。
ただし、レスポンスの meta.next や meta.prev で次のページや前のページのリクエスト用 URL が提供されるため、 そちらを利用したほうが良い場合もある。
取得するコミュニティノートのリストの最大数。 0 ～ 1000 まで指定できる。ページネーションに利用される。
ただし、レスポンスの meta.next や meta.prev で次のページや前のページのリクエスト用 URL が提供されるため、 そちらを利用したほうが良い場合もある。
取得するコミュニティノートが紐づいているトピックの ID。
GET /api/v1/data/topics で取得できるトピックの ID を指定することで、そのトピックに紐づいたコミュニティノートを取得できる。
複数指定した場合は、 いずれかのトピックに紐づいたコミュニティノート を取得する。 (AND 検索ではなく OR 検索になる)
コミュニティノートのデータ取得に利用する X の Post の ID。 コミュニティノートと Post は 1 : 1 で紐づいている。
複数回クエリパラメータを指定する / カンマ区切りで複数の ID を指定することで複数のコミュニティノートを一括で取得できる。
取得するコミュニティノートのステータス。
| X 上の表示 | current_statusに指定する値 |
|---|---|
| さらに評価が必要 | NEEDS_MORE_RATINGS |
| 現在のところ「役に立った」と評価されています | CURRENTLY_RATED_HELPFUL |
| 現在のところ「役に立たなかった」と評価されています | CURRENTLY_RATED_NOT_HELPFUL |
取得するコミュニティノートの言語。
ISO 639-1 に準拠した 2 文字の言語コードを指定することで、その言語のコミュニティノートのみを取得できる。
指定した文字列を含む Note を検索して取得する。検索は Note のSummaryに対して行われる。
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.