月次イベントを見る

POST

/rest/v1/getCalendarEvents

const url = 'https://game.retrogather.com/rest/v1/getCalendarEvents';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"month":"example","eventTypes":["LIBRARY_BUY"],"page":1,"limit":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://game.retrogather.com/rest/v1/getCalendarEvents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "month": "example", "eventTypes": [ "LIBRARY_BUY" ], "page": 1, "limit": 1 }'

Calendar / 月次イベント: derived events for one YYYY-MM month from library, wishlist, play, and consoles. Game events include title and platform. Release anniversaries are omitted. PLAY_START is omitted when the play starts and ends on the same day. Omitted types are listed with reasons.

Plans: FREE / LIGHT / PREMIUM. Scopes: library:read, play:read.

Authorizations

apiKey

Request Body^required

application/json

object

month

required

YYYY-MM

string

eventTypes

(LIGHT+: CONSOLE_BUY, CONSOLE_MAINTENANCE_SCHEDULED, CONSOLE_MAINTENANCE_DONE)

Array<string>

Allowed values: LIBRARY_BUY WISHLIST_PLAN PLAY_START PLAY_END PLAY_DROP PLAY_CLEAR_TARGET CONSOLE_BUY CONSOLE_MAINTENANCE_SCHEDULED CONSOLE_MAINTENANCE_DONE

page

integer

>= 1

limit

integer

>= 1 <= 200

Responses

200

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

application/json

Any of:

object
object

object

items

required

Array<object>

object

eventId

required

string

eventType

required

string

Allowed values: LIBRARY_BUY WISHLIST_PLAN PLAY_START PLAY_END PLAY_DROP PLAY_CLEAR_TARGET CONSOLE_BUY CONSOLE_MAINTENANCE_SCHEDULED CONSOLE_MAINTENANCE_DONE

eventDate

required

string

title

required

string

gameId

integer

platform

object

platformId

required

integer

name

string

key

additional properties

any

playId

string

consoleId

string

maintenanceLogId

string

dateSource

string

Allowed values: field createdAt updatedAt

key

additional properties

any

page

required

integer

returnedCount

required

integer

totalCount

required

integer

hasMore

required

boolean

effectiveLimit

integer

limitReduced

boolean

limitReason

string

includedEventTypes

Array<string>

Allowed values: LIBRARY_BUY WISHLIST_PLAN PLAY_START PLAY_END PLAY_DROP PLAY_CLEAR_TARGET CONSOLE_BUY CONSOLE_MAINTENANCE_SCHEDULED CONSOLE_MAINTENANCE_DONE

omittedEventTypes

Array<object>

object

eventType

required

string

Allowed values: LIBRARY_BUY WISHLIST_PLAN PLAY_START PLAY_END PLAY_DROP PLAY_CLEAR_TARGET CONSOLE_BUY CONSOLE_MAINTENANCE_SCHEDULED CONSOLE_MAINTENANCE_DONE

reason

required

string

key

additional properties

any

note

string

key

additional properties

any

Example

{
  "items": [
    {
      "eventType": "LIBRARY_BUY",
      "dateSource": "field"
    }
  ],
  "includedEventTypes": [
    "LIBRARY_BUY"
  ],
  "omittedEventTypes": [
    {
      "eventType": "LIBRARY_BUY"
    }
  ]
}

400

Invalid_input (arguments, broken JSON body)

application/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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

401

Missing or invalid API key

application/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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

403

Insufficient_scope, plan_required, or access_suspended

application/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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

404

Target or tool not found

application/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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

429

Burst or daily quota exceeded. See resetAt.

application/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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

Headers

Retry-After

integer

Seconds

500

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

application/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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

503

Temporary failure or maintenance. Retry after Retry-After.

application/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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

Headers

Retry-After

integer

Seconds

月次イベントを見る

Authorizations

Request Bodyrequired

Responses

200

Example

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

429

Examplegenerated

Headers

500

Examplegenerated

503

Examplegenerated

Headers

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated