Get group gains (single metric)
wom_get_group_gainedRetrieve the top gains leaderboard in a group for a specific metric over a period or custom date range. See which members gained the most XP, kills, or scores.
Instructions
Fetches the top gains leaderboard within a group for a single metric, over a period or custom date range.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The group's numeric Wise Old Man ID. | |
| limit | No | Max number of results (pagination). | |
| metric | Yes | A metric name. One of: a skill (overall, attack, defence, strength, hitpoints, ranged, prayer, magic, cooking, woodcutting, fletching, fishing, firemaking, crafting, smithing, mining, herblore, agility, thieving, slayer, farming, runecrafting, hunter, construction, sailing), a boss (abyssal_sire, alchemical_hydra, amoxliatl, araxxor, artio, barrows_chests, brutus, bryophyta, callisto, calvarion, cerberus, chambers_of_xeric, chambers_of_xeric_challenge_mode, chaos_elemental, chaos_fanatic, commander_zilyana, corporeal_beast, crazy_archaeologist, dagannoth_prime, dagannoth_rex, dagannoth_supreme, deranged_archaeologist, doom_of_mokhaiotl, duke_sucellus, general_graardor, giant_mole, grotesque_guardians, hespori, kalphite_queen, king_black_dragon, kraken, kreearra, kril_tsutsaroth, lunar_chests, maggot_king, mimic, nex, nightmare, phosanis_nightmare, obor, phantom_muspah, sarachnis, scorpia, scurrius, shellbane_gryphon, skotizo, sol_heredit, spindel, tempoross, the_gauntlet, the_corrupted_gauntlet, the_hueycoatl, the_leviathan, the_royal_titans, the_whisperer, theatre_of_blood, theatre_of_blood_hard_mode, thermonuclear_smoke_devil, tombs_of_amascut, tombs_of_amascut_expert, tzkal_zuk, tztok_jad, vardorvis, venenatis, vetion, vorkath, wintertodt, yama, zalcano, zulrah), an activity (bounty_hunter_hunter, bounty_hunter_rogue, clue_scrolls_all, clue_scrolls_beginner, clue_scrolls_easy, clue_scrolls_medium, clue_scrolls_hard, clue_scrolls_elite, clue_scrolls_master, last_man_standing, pvp_arena, soul_wars_zeal, guardians_of_the_rift, colosseum_glory, collections_logged), or a computed metric (ehp, ehb). | |
| offset | No | Number of results to skip (pagination). | |
| period | No | A time period. One of: five_min, day, week, month, year. Alternatively use startDate/endDate for a custom range. | |
| endDate | No | End of a custom date range (ISO 8601), used instead of `period`. | |
| startDate | No | Start of a custom date range (ISO 8601), used instead of `period`. |