利用者の記録・レビュー・ステータス変更を、時系列のアクティビティとして取得するエンドポイントです。
リクエストの送り方やページネーションについてはREST API V1の概要をご参照ください。
GET /v1/activities
アクティビティを取得することができます。
フィールド
どのアクティビティにも共通して、次のフィールドが入ります。
| 名前 | 概要 |
|---|---|
| id | アクティビティID |
| user | ユーザ情報。取得できるフィールドはREST API V1のユーザと同じです。 |
| work | 作品情報。取得できるフィールドはREST API V1の作品と同じです。 |
| action | アクティビティの種類。create_record (記録), create_review (レビュー), create_multiple_records (一括記録), create_status (ステータス変更) の4種類が存在します。 |
| created_at | アクティビティ作成日時 |
これに加えて、action ごとに次のフィールドが入ります。
| action | フィールド | 概要 |
|---|---|---|
| create_record | episode | 記録されたエピソード情報。REST API V1のエピソードの id から record_comments_count までのフィールドが入ります。 |
| create_record | record | 記録情報。取得できるフィールドはREST API V1のエピソードへの記録と同じです。 |
| create_review | review | レビュー情報。取得できるフィールドはREST API V1の作品へのレビューと同じです。 |
| create_multiple_records | multiple_record | 一括記録の情報。記録されたエピソードの数だけ record と episode の組が配列で入ります。 |
| create_status | status.kind | ステータスの種類 |
record と review には、user / work / episode は入りません。
アクティビティ本体の user と work を参照してください。
パラメータ
| 名前 | 概要 | 使用例 |
|---|---|---|
| fields | レスポンスボディに含まれるデータのフィールドを絞り込みます。 | fields=id,work.title |
| filter_user_id | ユーザIDで絞り込みます。 | filter_user_id=2 |
| filter_username | ユーザ名で絞り込みます。 | filter_username=shimbaco |
| filter_actions | アクションで絞り込みます。指定できるのは1つだけです。 | filter_actions=create_record |
| page | ページ数を指定します。 | page=2 |
| per_page | 1ページに何件取得するかを指定します。デフォルトは 25 件で、50 件まで指定できます。 |
per_page=30 |
| sort_id | IDで並び替えます。asc または desc が指定できます。 |
sort_id=desc |
リクエスト例
$ curl -X GET https://api.annict.com/v1/activities?access_token=(access_token)&sort_id=desc&filter_username=shimbaco&per_page=1
{
"activities": [
{
"id": 1504708,
"user": {
"id": 2,
"username": "shimbaco",
"name": "Koji Shimba",
"description": "アニメ好きが高じてこのサービスを作りました。",
"url": "http://shimba.co",
"avatar_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_avatars/master/d8af7adc8122c96ba7639218fd8b5ede332d42f2.jpg?1431357292",
"background_image_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_background_images/master/ee15d577fb2f2d61bdaf700cfab894b286a5762d.jpg?1486753229",
"records_count": 2369,
"followings_count": 258,
"followers_count": 205,
"wanna_watch_count": 237,
"watching_count": 103,
"watched_count": 335,
"on_hold_count": 45,
"stop_watching_count": 244,
"created_at": "2014-03-02T15:38:40.000Z"
},
"action": "create_record",
"created_at": "2017-02-22T13:24:44.761Z",
"work": {
"id": 5036,
"title": "小林さんちのメイドラゴン",
"title_kana": "こばやしさんちのめいどらごん",
"title_en": "Miss Kobayashi's Dragon Maid",
"media": "tv",
"media_text": "TV",
"released_on": "",
"released_on_about": "",
"official_site_url": "http://maidragon.jp/",
"wikipedia_url": "https://ja.wikipedia.org/wiki/%E5%B0%8F%E6%9E%97%E3%81%95%E3%82%93%E3%81%A1%E3%81%AE%E3%83%A1%E3%82%A4%E3%83%89%E3%83%A9%E3%82%B4%E3%83%B3",
"twitter_username": "maidragon_anime",
"twitter_hashtag": "maidragon",
"episodes_count": 7,
"watchers_count": 448,
"season_name": "2017-winter",
"season_name_text": "2017年冬"
},
"episode": {
"id": 89678,
"number": "6",
"number_text": "#6",
"sort_number": 60,
"title": "お宅訪問！(してないお宅もあります)",
"records_count": 89,
"record_comments_count": 24
},
"record": {
"id": 864718,
"comment": "",
"rating": null,
"rating_state": null,
"is_modified": false,
"likes_count": 0,
"comments_count": 0,
"created_at": "2017-02-22T13:24:39.353Z"
}
}
],
"total_count": 3705,
"next_page": 2,
"prev_page": null
}
GET /v1/me/following_activities
自分がフォローしているユーザのアクティビティを取得することができます。
自分自身のアクティビティも一緒に返ります。
フィールド
取得できるフィールドは GET /v1/activities と同じです。
パラメータ
| 名前 | 概要 | 使用例 |
|---|---|---|
| fields | レスポンスボディに含まれるデータのフィールドを絞り込みます。 | fields=id,work.title |
| filter_actions | アクションで絞り込みます。指定できるのは1つだけです。 | filter_actions=create_record |
| filter_muted | ミュート機能でミュートしているユーザを除外するかどうかを指定します。true で除外、false で除外しないようにできます。デフォルトは true (除外する) です。 |
filter_muted=false |
| page | ページ数を指定します。 | page=2 |
| per_page | 1ページに何件取得するかを指定します。デフォルトは 25 件で、50 件まで指定できます。 |
per_page=30 |
| sort_id | IDで並び替えます。asc または desc が指定できます。 |
sort_id=desc |
リクエスト例
$ curl -X GET https://api.annict.com/v1/me/following_activities?access_token=(access_token)&sort_id=desc&per_page=1
レスポンスは GET /v1/activities と同じ形式です。