Documentation Powered by ReDoc

UkaAPI Document (1.0.0)

Download OpenAPI specification:Download

License: MIT

sessions

Get session

要求権限：なし

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "display_name": "string",
  • "point": 0,
  • "icon_url": "string",
  • "rank": 0
}

Delete session

要求権限：USER以上

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

trends

Twitterトレンド取得

要求権限：なし

Responses

Response samples

Content type
application/json
{
  • "trend_words":
    [
    ]
}

hit_logs

任意のユーザの予測ヒット履歴を取得

要求権限：なし

query Parameters
user_id
required
string
start
integer
Default: 0
limit
integer
Default: 6

Responses

Response samples

Content type
application/json
{
  • "date": "2019-08-24T14:15:22Z",
  • "rank": 0,
  • "word": "string"
}

users

ログインユーザ情報を取得

要求権限：USER以上

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "display_name": "string",
  • "point": 0,
  • "icon_url": "string",
  • "rank": 0
}

ログインユーザ情報を更新

要求権限：USER以上

Request Body schema: application/json
display_name
string [ 1 .. 50 ] characters
join_rank
boolean

Responses

Request samples

Content type
application/json
{
  • "display_name": "string",
  • "join_rank": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "display_name": "string",
  • "point": 0,
  • "icon_url": "string",
  • "rank": 0
}

ユーザのプロフィールを取得

要求権限：なし

path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "display_name": "string",
  • "point": 0,
  • "icon_url": "string",
  • "rank": 0
}

rakings

ユーザランキング

要求権限：なし

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "display_name": "string",
  • "point": 0,
  • "icon_url": "string",
  • "rank": 0
}

predict_word

設定中のトレンド予測ワードを取得

要求権限：USER以上

Responses

Response samples

Content type
application/json
{
  • "predict_words":
    [
    ]
}

トレンド予測ワードを設定

要求権限：USER以上

Request Body schema: application/json
predict_words
Array of strings

Responses

Request samples

Content type
application/json
{
  • "predict_words":
    [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

version

バックエンドバージョンを取得

要求権限： なし

Responses

Response samples

Content type
application/json
"string"