Wizards Vault API Bugs/Suggestions

lambada commented 4 months ago

[Feedback gathered from GW2 API Dev Community after the WV API Release]

Localization problems

https://api.guildwars2.com/v2 shows /v2/wizardsvault/listings and /v2/wizardsvault/objectives as being localised.

/v2/wizardsvault/listings contains no localized data, so the flag is redundant.
/v2/wizardsvault and /v2/wizardsvault/objectives do not respect the lang query parameter, and so the objective names are not localized, despite being flagged as being localised
/v2/account/wizardsvault/{daily,weekly,special} contains localised data but is not flagged as being localised and does not respect the lang query parameter

Redundant data

/v2/account/wizardsvault/{daily,weekly,special} duplicates a lot of data from v2/wizardsvault/objectives/:id. It would be better for it to return just ~~a simple array of objective IDs that match with the objectives API~~ an array of objects with id, progress_current, progress_complete and claimed and not ~~expanded objects with~~ redundant data like title, track or acclaim. That would also remove the localised data for that endpoint.

Missing data

/v2/wizardsvault/listings should return purchase_limit like the v2/account/wizardsvault/listings endpoint does.
There is also no programmatic way of determining which listings are restricted to accounts with specific purchases - eg most Legacy rewards currently require SotO. E.G. Listing ID 29 corresponds to https://api.guildwars2.com/v2/items/100663 but neither says it's Soto restricted
Some special events have a time limit (for example "Bonus Week: Complete the Return to Heart of Thorns Achievement"). This should be included in the API.

Stale Data

The objectives for an account only update upon the account logging in for that day/week(/season?). Given the objectives are tied to which types you have slected (PvE/PvP/WvW), it would be more useful to have an API that exposes which options an account has selected (e.g. v2/account could contain "wizardsvault_tracks": ["PvE", "PvP"], and update /v2/wizardsvault/objectives to have a required_tracks property or similar. This would then allow calculation of the current objectives without needing an account to have logged in.
Another side effect of the API only updating when an account logs in, is that the progress under /v2/account/wizardsvault/{daily,weekly,special} can be misleading. If the above suggestion is implemented, then the API should show 0 progress if the account has not logged in for that day/week.

darthmaim commented 4 months ago

Kinda related: Only the weekly meta_reward_item_id is whitelisted, the daily chest is missing (https://api.guildwars2.com/v2/items?ids=99961,100137)

darthmaim commented 4 months ago

The objectives are missing the description that is visible in the tooltip ingame.

It would maybe also be useful to some to get the astral acclaim and objective type icons added to /v2/files

sliekens commented 4 months ago

Suggestion: add ids=all to the root endpoint, to get an aggregate of all the listings and objectives.

GET https://api.guildwars2.com/v2/wizardsvault?ids=all&lang=en&v=latest

response

``` json { "title": "The Realm of Dreams Season", "start": "2022-11-07T17:00:00Z", "end": "2024-05-14T16:00:00Z", "listings": [ { "id": 1, "item_id": 101574, "item_count": 1, "type": "Featured", "cost": 500 }, { "id": 2, "item_id": 101617, "item_count": 1, "type": "Featured", "cost": 500 }, { "id": 3, "item_id": 101485, "item_count": 1, "type": "Featured", "cost": 150 }, ... ], "objectives": [ { "id": 1, "title": "Complete 3 Events", "track": "PvE", "acclaim": 10 }, { "id": 2, "title": "Compete in 1 Player vs. Player Team Battle", "track": "PvP", "acclaim": 10 }, { "id": 3, "title": "Complete 5 Bounty Missions in Crystal Oasis or Group Events", "track": "PvE", "acclaim": 50 }, ... ] } ```

@sliekens wouldn't it be kinda weird to use ids, because one might think ids=1 is then also possible?

I agree it's inconsistent with anything that came before it, other suggestions:

Change the root endpoint to return the full representations of listings and objectives, always
Introduce a new argument to expand the collections, e.g. expand=listings,objectives
Replace the fields with HATEOAS style links

GET https://api.guildwars2.com/v2/wizardsvault?lang=en&v=latest

{
    "title": "The Realm of Dreams Season",
    "start": "2022-11-07T17:00:00Z",
    "end": "2024-05-14T16:00:00Z",
    "links": {
        "listings": "/v2/wizardsvault/listings?lang=en&v=latest",
        "objectives": "/v2/wizardsvault/objectives?lang=en&v=latest"
    }
}

darthmaim commented 4 months ago

I've played around with the Wizard's Vault endpoints for a week now (you can test my implementation here: https://en.gw2treasures.com/wizards-vault).

The biggest issue is obviously the need to login to the game before it returns data, but the second biggest issue I've noticed is the cache time. The authenticated objectives endpoints return a cache max-age of 60 minutes. Even when requesting with no-cache, data takes up to one hour to show up (fastest I've seen was about 5 minutes, average seems to be about 10 - 15 minutes). That makes the the endpoints basically useless to track daily objectives, because you will have completed all dailies before the endpoint even returns data for the correct day. The cache time should be dropped to max 5 minutes, better just 1 minute.

darthmaim commented 5 days ago

Just noticed that the /v2/wizardsvault/objectives endpoint sometimes returns localized data, I suspect the language is missing in some cache key.

gw2-api / issues