Checkpoint
A recap of the user's yearly activity, inspired by Spotify Wrapped.
Endpoints
Get Checkpoint
GET/checkpointRetrieves the user's current yearly checkpoint.
Response Body
| Field | Type | Description |
|---|---|---|
| card_id? | integer | The type of checkpoint card |
| avatar_decoration | avatar decoration collectible item | A free avatar decoration granted by viewing the checkpoint |
| power_level? | float | A power level representing how active the user was on Discord |
| power_level_percentile? | float | The power level expressed as a percentile |
| messages? | checkpoint message statistics object | Statistics about messages sent by the current user during the year |
| emojis? | checkpoint emoji statistics object | Statistics about emojis the current user used during the year |
| voice? | checkpoint voice statistics object | Statistics about voice activity from the current user during the year |
| guilds? | checkpoint guilds statistics object | Statistics about guilds the current user was active in during the year |
| sidekick? | checkpoint sidekick object | The user the current user talk to the most |
| users? | array[checkpoint user object] | Additional users the current user spent the most time with during the year |
| applications? | checkpoint games statistics object | Games played during the year |
| quests? | checkpoint quest statistics object | Number of completed quests and collected orbs during the year |
Checkpoint Card Type
| Value | Name |
|---|---|
| 0 | PLANT |
| 1 | DONUT |
| 2 | DOG_IN_SWIM_RING |
| 3 | DISCO_BALL |
| 4 | ORIGAMI_PAPER_CRANE |
| 5 | SNAIL |
| 6 | DUCK_WITH_SUNGLASSES |
| 7 | BANANA |
| 8 | CAT |
| 9 | CARTRIDGE |
Checkpoint Message Statistics Structure
| Field | Type | Description |
|---|---|---|
| num_messages_sent | integer | Number of messages the current user sent during the year |
| num_messages_sent_percentile | ?float | The user's rank in message-sending activity compared to all users, expressed as a percentile |
| top_month | ?checkpoint message top month statistics object | The month the current user sent the most messages during the year |
Checkpoint Message Top Month Statistics Structure
| Field | Type | Description |
|---|---|---|
| month | integer | The top month (1-12) |
| num_messages_sent | integer | Number of messages the current user sent within the month |
Checkpoint Emoji Statistics Structure
| Field | Type | Description |
|---|---|---|
| num_emojis_sent | integer | Number of emojis used (includes messages with emojis and reactions) |
| emojis | array[partial emoji object] | Up to 5 emojis the current user used the most |
Checkpoint Voice Statistics Structure
| Field | Type | Description |
|---|---|---|
| total_voice_minutes | float | Duration in seconds how much time the user spent in voice channels for year |
| total_voice_minutes_percentile | ?float | The user's rank in voice activity compared to all users, expressed as a percentile |
| top_month | ?checkpoint voice top month statistics object | The month the current user participated in calls the most |
Checkpoint Voice Top Month Statistics Structure
| Field | Type | Description |
|---|---|---|
| month | integer | The top month (1-12) |
| num_minutes_in_voice | float | Duration in minutes that the current user spent in a call |
Checkpoint Guilds Statistics Structure
| Field | Type | Description |
|---|---|---|
| num_guilds_joined | integer | Number of guilds the current user joined |
| guilds | array[checkpoint guild statistics object] | Up to 3 guilds the current user participated in the most |
Checkpoint Guild Statistics Structure
| Field | Type | Description |
|---|---|---|
| num_messages_sent? | integer | Number of messages the current user sent in the guild during the year |
| num_voice_minutes? | float | Duration in minutes that the current user spent in guild voice |
| guild | partial guild object | The guild |
Checkpoint Sidekick Structure
| Field | Type | Description |
|---|---|---|
| user | partial user object | The sidekick user |
| num_messages_sent | integer | Number of messages the current user sent in the user's DM |
| num_voice_minutes | float | Duration in minutes the current user spent being in call with the user |
Checkpoint User Structure
| Field | Type | Description |
|---|---|---|
| user | partial user object | The user |
Checkpoint Games Statistics Structure
| Field | Type | Description |
|---|---|---|
| total_games_played | integer | Total amount of games played |
| applications | array[checkpoint game statistics object] | Statistics about games played |
Checkpoint Game Statistics Structure
| Field | Type | Description |
|---|---|---|
| num_sessions | integer | Number of game sessions |
| game | partial application object | The game application |
Checkpoint Quest Statistics Structure
| Field | Type | Description |
|---|---|---|
| num_completed | integer | Number of completed quests |
| num_orbs | integer | Amount of collected Orbs from quests |
Example Response Body
{ "card_id": 5, "avatar_decoration": { "type": 0, "id": "1440174720640352344", "sku_id": "1440174638930853954", "asset": "a_523d7733d1b88cfbad5b082d062defc4", "assets": { "static_image_url": "https://cdn.discordapp.com/assets/content/0a5c302e0a0e20ee64754723466ab8cc740b304901697cf9ede00211bda6e138", "animated_image_url": "https://cdn.discordapp.com/assets/content/d8a4a1544816b6034e28b06a52c2c0489677c6626c977671959a9e9f68915670" }, "label": "A snail avatar decoration." }, "power_level": 83732.32311666667, "power_level_percentile": 87.039, "messages": { "num_messages_sent": 53146, "num_messages_sent_percentile": 99.19, "top_month": { "month": 7, "num_messages_sent": 6811 } }, "emojis": { "num_emojis_sent": 13096, "emojis": [ { "id": "1145727546747535412", "name": "blobcatcozy", "animated": false }, { "name": "💀" }, { "id": "1030570693903011921", "name": "husk", "animated": false } { "name": "ðŸ˜" }, { "name": "🔥" } ] }, "voice": { "total_voice_minutes": 6.3231166666666665, "total_voice_minutes_percentile": null, "top_month": { "month": 7, "num_minutes_in_voice": 6.23785 } }, "guilds": { "num_guilds_joined": 11, "guilds": [ { "num_messages_sent": 3711, "num_voice_minutes": 0.0, "guild": { "id": "1046920999469330512", "name": "Alien Network", "icon": "66b0f4d96c145970fa9d96ada8afadf3", "description": "Where the 👽s 👽 and sometimes very 👽 things happen 😨.", "home_header": "39ba384a31e9c285649ad00b359946ab", "splash": "b40e61f7730b8781b9a551964570e0cc", "discovery_splash": "0e11ae8d9f1c86958be05e61b0c90ac3", "features": [] } }, { "guild": { "id": "302094807046684672", "name": "MINECRAFT", "icon": "24f8bc7ec317e6eaaa0d8352720a7dfe", "description": "The official Minecraft Discord!", "home_header": null, "splash": "5d84dff0dfaa9c2f4f23a0612564383b", "discovery_splash": "5d84dff0dfaa9c2f4f23a0612564383b", "features": [ "ANIMATED_BANNER" "ANIMATED_ICON", "BANNER", "COMMUNITY", "DISCOVERABLE", "ENABLED_DISCOVERABLE_BEFORE", "PREVIEW_ENABLED", "VANITY_URLS", "VERIFIED", "VIP_REGIONS" ] } }, { "guild": { "id": "322850917248663552", "name": "Official Fortnite", "icon": "aeed50fc9dadcdb03958f66d53aed053", "description": "The Official Fortnite Discord Server! Join to follow news & updates, LFG, and chat about all things Fortnite!", "home_header": null, "splash": "e942dd9672490882b3c1cccb1bddc365", "discovery_splash": "64f47845f91d4b77ab2af0cfd4551978", "features": [ "ANIMATED_BANNER", "ANIMATED_ICON", "BANNER", "COMMUNITY", "DISCOVERABLE", "FEATURABLE", "INVITE_SPLASH", "VANITY_URL", "VERIFIED", "VIP_REGIONS" ] } } ] }, "sidekick": { "user": { "id": "852892297661906993", "username": "dolfies", "global_name": "Dolfies", "avatar": "c78ef8fb1db15a3d5f1b4c057856c5c9", "avatar_decoration_data": null, "collectibles": null, "discriminator": "0", "display_name_styles": null, "public_flags": 264, "primary_guild": null }, "num_messages_sent": 869, "num_voice_minutes": 0.0 }, "users": [ { "user": { "id": "246877849162743818", "username": "jay_taelien", "global_name": "Jay", "avatar": "91b7bc37e924f78625f7ea582fdbac5d", "avatar_decoration_data": null, "collectibles": null, "discriminator": "0", "display_name_styles": null, "public_flags": 16512, "primary_guild": null } }, { "user": { "id": "1001086404203389018", "username": ".dziurwa", "global_name": "Dziurwa💕", "avatar": "f6c0363fbab45668fcf8f88fea56db9c", "avatar_decoration_data": null, "collectibles": null, "discriminator": "0", "display_name_styles": null, "public_flags": 16640, "primary_guild": null } } ], "applications": { "total_games_played": 2, "applications": [ { "num_sessions": 7, "game": { "id": "363445589247131668", "name": "Roblox", "icon_hash": "f2b60e350a2097289b3b0b877495e55f", "banner_hash": "e970e33dd647f87dc87f4dc4b28f4627", "cover_image_hash": "82f092687242e81976b955927df9cd24" } }, { "num_sessions": 3, "game": { "id": "1402418703554842694", "name": "Fortnite", "icon_hash": "f2b60e350a2097289b3b0b877495e55f", "banner_hash": null, "cover_image_hash": "c1864b38910c209afd5bf6423b672022" } } ] }, "quests": { "num_completed": 73, "num_orbs": 22500 }}Claim Checkpoint Avatar Decoration
POST/checkpoint/lootClaims the free avatar decoration collectible from the checkpoint. Returns a 204 empty response.