コンテンツにスキップ

プレイ記録の分析

GET
/rest/v1/getPlayAnalytics
curl --request GET \
--url 'https://game.retrogather.com/rest/v1/getPlayAnalytics?clearTargetOverdue=overdue&playTimeTrendGranularity=day' \
--header 'Authorization: Bearer <token>'

Play analytics / プレイ記録の分析: stats for play records and play time. Default section is summary only. monthlyTrend.endedCount is status-agnostic; monthlyResults splits clears vs dropped. Attribute counts can exceed record counts. playTimeTrend reads PlayLog minutes for at most 90 JST days. Default uses the latest record per game. Filters match getPlayRecords.

Arrays are comma-separated. Percent-encode query values; Japanese values are easier to send with POST JSON. Plans: FREE / LIGHT / PREMIUM. Scopes: play:read. FREE: not available: consoleIds, includeHistory (see x-rgg-plan-differences). LIGHT: not available: includeHistory (see x-rgg-plan-differences).

sections
Array<string>
Allowed values: summary status rating monthlyTrend monthlyResults releasePeriod completionPace console platform genre attributes playTimeTrend

(LIGHT+: console)

statuses
Array<string>
Allowed values: PLANNED PLAYING PAUSED COMPLETED DROPPED

Play statuses (OR)

platformIds
Array<integer>
<= 10 items

Platform IDs (OR)

genreId
integer
>= 1

Genre ID from listGenres. A root ID matches the game’s genreId or genreSubId. A non-root ID matches titleKana using that genre’s taxonomy key.

title
string
<= 30 characters

Title, reading, or edition name

attributes
Array<string>
<= 5 items

Attribute IDs or labels (AND)

consoleIds
Array<string>
<= 5 items

Played console IDs (OR) (LIGHT+)

playStartDateFrom
string format: date

YYYY-MM-DD

playStartDateTo
string format: date

YYYY-MM-DD

playEndDateFrom
string format: date

YYYY-MM-DD

playEndDateTo
string format: date

YYYY-MM-DD

clearTargetDateFrom
string format: date

YYYY-MM-DD

clearTargetDateTo
string format: date

YYYY-MM-DD

clearTargetOverdue
string
Allowed values: overdue not_overdue

Overdue: unfinished (PLANNED/PLAYING/PAUSED) with clearTargetDate before today. COMPLETED/DROPPED are never overdue.

totalPlayTimeFrom
integer

Total play time from (minutes)

totalPlayTimeTo
integer

Total play time to (minutes)

ratingFrom
integer
>= 1 <= 5

Minimum rating (1-5)

ratingTo
integer
>= 1 <= 5

Maximum rating (1-5)

releaseYearFrom
integer

Release year from (inclusive). Analytics/export axis stays yearly.

releaseYearTo
integer

Release year to (inclusive). Analytics/export axis stays yearly.

playTimeTrendFrom
string format: date

YYYY-MM-DD (JST), inclusive. playTimeTrend covers at most 90 days; default is the 90 days up to today.

playTimeTrendTo
string format: date

YYYY-MM-DD (JST), inclusive.

playTimeTrendGranularity
string
Allowed values: day week month
includeHistory
boolean

True counts every play cycle instead of the latest record per game. (PREMIUM)

Tool result JSON (no MCP envelope). Delete previews also return 200 with confirmToken.

Media typeapplication/json
Any of:
object
summary
object
key
additional properties
any
status
Array<object>
object
key
additional properties
any
rating
Array<object>
object
key
additional properties
any
monthlyTrend
Array<object>
object
key
additional properties
any
monthlyResults
Array<object>
object
key
additional properties
any
releasePeriod
Array<object>
object
key
additional properties
any
completionPace
object
key
additional properties
any
console
Array<object>
object
key
additional properties
any
platform
Array<object>
object
key
additional properties
any
genre
Array<object>
object
key
additional properties
any
attributes
object
key
additional properties
any
playTimeTrend
object
key
additional properties
any
key
additional properties
any
Example
{
"code": "plan_required",
"status": "PLANNED",
"items": [
{
"status": "added"
}
]
}

Invalid_input (arguments, broken JSON body)

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object
error
string
code
string
message
string
retryable
boolean
retryAfterSec
integer
requestId
string
resetAt
string
remaining
integer
scopes
Array<string>
upgradeUrl
string
key
additional properties
any
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"retryable": true,
"retryAfterSec": 1,
"requestId": "example",
"resetAt": "example",
"remaining": 1,
"scopes": [
"example"
],
"upgradeUrl": "example"
}

Missing or invalid API key

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object
error
string
code
string
message
string
retryable
boolean
retryAfterSec
integer
requestId
string
resetAt
string
remaining
integer
scopes
Array<string>
upgradeUrl
string
key
additional properties
any
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"retryable": true,
"retryAfterSec": 1,
"requestId": "example",
"resetAt": "example",
"remaining": 1,
"scopes": [
"example"
],
"upgradeUrl": "example"
}

Insufficient_scope, plan_required, or access_suspended

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object
error
string
code
string
message
string
retryable
boolean
retryAfterSec
integer
requestId
string
resetAt
string
remaining
integer
scopes
Array<string>
upgradeUrl
string
key
additional properties
any
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"retryable": true,
"retryAfterSec": 1,
"requestId": "example",
"resetAt": "example",
"remaining": 1,
"scopes": [
"example"
],
"upgradeUrl": "example"
}

Target or tool not found

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object
error
string
code
string
message
string
retryable
boolean
retryAfterSec
integer
requestId
string
resetAt
string
remaining
integer
scopes
Array<string>
upgradeUrl
string
key
additional properties
any
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"retryable": true,
"retryAfterSec": 1,
"requestId": "example",
"resetAt": "example",
"remaining": 1,
"scopes": [
"example"
],
"upgradeUrl": "example"
}

Burst or daily quota exceeded. See resetAt.

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object
error
string
code
string
message
string
retryable
boolean
retryAfterSec
integer
requestId
string
resetAt
string
remaining
integer
scopes
Array<string>
upgradeUrl
string
key
additional properties
any
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"retryable": true,
"retryAfterSec": 1,
"requestId": "example",
"resetAt": "example",
"remaining": 1,
"scopes": [
"example"
],
"upgradeUrl": "example"
}
Retry-After
integer

Seconds

Unexpected server failure. Retrying the same call will not help.

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object
error
string
code
string
message
string
retryable
boolean
retryAfterSec
integer
requestId
string
resetAt
string
remaining
integer
scopes
Array<string>
upgradeUrl
string
key
additional properties
any
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"retryable": true,
"retryAfterSec": 1,
"requestId": "example",
"resetAt": "example",
"remaining": 1,
"scopes": [
"example"
],
"upgradeUrl": "example"
}

Temporary failure or maintenance. Retry after Retry-After.

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object
error
string
code
string
message
string
retryable
boolean
retryAfterSec
integer
requestId
string
resetAt
string
remaining
integer
scopes
Array<string>
upgradeUrl
string
key
additional properties
any
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"retryable": true,
"retryAfterSec": 1,
"requestId": "example",
"resetAt": "example",
"remaining": 1,
"scopes": [
"example"
],
"upgradeUrl": "example"
}
Retry-After
integer

Seconds