Search Count
検索結果の総件数を取得するエンドポイント
get/api/v1/data/search/count
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/search/count
- Auth: none declared
Query parameters
note_includes_textstring[] nullable
指定した文字列を含む Note を検索して取得する。検索は Note のSummaryに対して行われる。
note_excludes_textstring nullable
指定した文字列を含む Note を検索して取得する。検索は Note のSummaryに対して行われる。
post_includes_textstring[] nullable
指定した文字列を含む Post を検索して取得する。検索は Post の本文に対して行われる。
post_excludes_textstring nullable
指定した文字列を含む Post を検索して取得する。検索は Post の本文に対して行われる。
languagestring nullable
取得するコミュニティノートの言語。
ISO 639-1 に準拠した 2 文字の言語コードを指定することで、その言語のコミュニティノートのみを取得できる。
topic_idsinteger[] nullable
取得するコミュニティノートが紐づいているトピックの ID。
GET /api/v1/data/topics で取得できるトピックの ID を指定することで、そのトピックに紐づいたコミュニティノートを取得できる。
複数指定した場合は、 いずれかのトピックに紐づいたコミュニティノート を取得する。 (AND 検索ではなく OR 検索になる)
note_statusstring[] nullable
取得するコミュニティノートのステータス。
| X 上の表示 | current_statusに指定する値 |
|---|---|
| さらに評価が必要 | NEEDS_MORE_RATINGS |
| 現在のところ「役に立った」と評価されています | CURRENTLY_RATED_HELPFUL |
| 現在のところ「役に立たなかった」と評価されています | CURRENTLY_RATED_NOT_HELPFUL |
x_user_namesstring[] nullable
Xのユーザー名
x_user_followers_count_frominteger nullable
Xのユーザーのフォロワー数。
x_user_follow_count_frominteger nullable
Xのユーザーのフォロー数。
post_like_count_frominteger nullable
Postのお気に入り数。
post_repost_count_frominteger nullable
Postのリポスト数。
post_impression_count_frominteger nullable
Postのインプレッション数。
post_includes_mediaboolean nullable
メディア情報を含んでいるか。
note_search_mode'or' | 'and'
note_includes_text で指定した複数キーワードの結合方法。
| 値 | 意味 |
|---|---|
| or | いずれかのキーワードを含むノートを取得 |
| and | すべてのキーワードを含むノートのみを取得 |
post_search_mode'or' | 'and'
post_includes_text で指定した複数キーワードの結合方法。
| 値 | 意味 |
|---|---|
| or | いずれかのキーワードを含むポストを取得 |
| and | すべてのキーワードを含むポストのみを取得 |
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.