TimeLine検索
タイムラインのタイトル、概要、タグにマッチするタイムラインを検索するAPIについて説明します。
リクエストURL
- 機能 :
- キーワードやオーナーからタイムラインを検索します。
リクエストメソッド
GETまたはPOST
リクエストパラメータ
| パラメータ | 項目名 | 説明 | 必須 | 値 | デフォルト値 |
|---|---|---|---|---|---|
| timeline_key | APIキー | APIを利用するためのキー(プライベートモードのタイムラインを参照する場合に必要となります。詳しくはAPIキーについてを参照してください。) | - | 英数字 | - |
| owner | 作成者 | タイムラインの作成者(ニックネーム) | (※1) | 英数字 | - |
| phrase | タイムライン検索フレーズ | タイムラインの全文検索フレーズ | (※1) | 文字列 | - |
| page | 取得ページ | タイムライン一覧のページ番号 | - | 数値 | 1 |
| hits | 取得件数 | レスポンスに含まれるタイムラインの件数 | - | 数値 | 20 |
| order | 表示順指定 | タイムラインのソート順 | - | (後述) | updated |
※1 「作成者(owner)」もしくは「タイムライン検索フレーズ(phrase)」の指定が必須となります。
プライベートモードのタイムラインを取得するには「APIキー」と「作成者」の指定を必須とし、作成者がAPIの利用者と一致する場合にのみ取得できます。 それ以外のケースではプライベートモードのタイムラインは結果に含まれなません。
「作成者」と「タイムライン検索フレーズ」の検索条件指定はそれぞれ排他です、同時に指定された場合は「作成者」による検索を優先されます。
「表示順指定」は以下のいずれかの値を取ります。
- hot: タイムライン人気降順(point要素の降順でソートします)
- created: タイムラインの作成時刻降順(created_at要素の降順でソートします)
- updated: タイムラインの編集時刻降順(updated_at要素の降順でソートします)
サンプルリクエストURL
レスポンス
レスポンスは以下の要素から構成されます。| 要素名 | 説明 | 値 |
|---|---|---|
| response | ||
| status | ||
| code | ステータスコード | 数値 |
| message | ステータスメッセージ | 文字列 |
| language | 言語情報 | 文字列 |
| result | ||
| summary | ||
| total | 検索にヒットしたタイムラインの全件数 | 数値 |
| page | 現在のページ | 文字列 |
| page_count | ページ総数 | 文字列 |
| timelines | タイムラインの一覧 | |
| timeline | タイムラインの詳細 |
サンプルレスポンス
以下は、このリクエストに対するレスポンスのサンプルです。
エラー
検索条件が不完全な場合はエラーとなります。
