ユーザーリスト
トピックイットAPIで取得できるデータの種類を詳しくご説明します。
なお、各リクエストの{ } 部分は、必ずURLエンコードしてください。文字コードはShift-JISです。
リクエストURL
- 機能:
- 条件にマッチしたユーザーリストを取得する。
上記のリクエスト例の場合は、user_nameでユーザーを指定し、そのユーザーのステータス等を取得します。
リクエスト
| GET | 内容 |
|---|---|
| /api/v1/users | 全ユーザ |
| /api/v1/users/{user name} | {user name}にマッチするユーザ |
| /api/v1/users/{comma-separated list of user name} | {user name}にマッチするユーザ (E.g., GET /user/Hiroky,aaa,bbb) |
共通パラメーター
| パラメータ名 | パラメータ | 値 | デフォルト | 内容 |
|---|---|---|---|---|
| 検索開始登録日時 | min_day | Number | - | UNIX epoch |
| 検索終了登録日時 | max_day | Number | - | UNIX epoch |
| ソート(登録日時) | sort_day | String | desc | desc, asc |
| ソート(ポイント) | sort_point | String | desc | desc, asc |
| ユーザー数 | count | Number | - | 取得件数 |
レスポンス
| 項目名 | パラメータ |
|---|---|
| ニックネーム | nickname |
| ポイント | points |
| 投稿数 | posts |
| コメント数 | comennts |
| 投票数 | votes |
| 会員登録日時 | created |
サンプルレスポンス
以下は、/api/v1/users?count=20のリクエストに対するレスポンスです。
