Get time in world
/api/vrchat-users/metricsHow long this person has been seen in world, where, and how often. Computed from the companion's presence reports, so it only covers time a moderator's client was in the same instance. Somebody who has never shared an instance with the client reads as nothing here, which is not the same as never having been in one — and the screen says so.
Gated on ViewProfile rather than ViewAnalytics: this is one person's own record rather than an aggregate, and it sits beside the rest of their profile.
Needs the ViewProfile permission.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Query Parameters
Also accepted as id.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/vrchat-users/metrics?vrchatUserId=string"{ "userId": "string", "known": true, "counts": { "minutesSeen": 0.1, "worlds": 0, "instances": 0, "arrivals": 0, "firstSeenAt": null, "lastSeenAt": null }, "recentInstances": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "location": "string", "worldId": "string", "worldName": null, "worldThumbnailImageUrl": null, "vrChatInstanceId": null, "instanceName": null, "groupAccessType": null, "region": null, "openedAt": "2019-08-24T14:15:22Z", "closedAt": null, "closedBy": null, "peopleNow": null, "peakPeople": null, "minutesOpen": 0.1, "worldCapacity": null, "worldPlatforms": null, "closedByModerator": false, "peopleNowUnsure": false, "peakPeopleUnsure": false } ], "now": "2019-08-24T14:15:22Z"}Get VRChat profile GET
The profile as of `lastRefreshedAt`, never fresher. `stale` says whether it is older than the sync's own threshold. `eighteenPlus` is Modbot's sticky flag: true once the person has ever been seen as 18+ verified, cleared only by a moderator -- it can disagree with `ageVerificationStatusLastSeen`, and that is the point. `refresh.pending` is true while a refresh is queued or in flight; poll this endpoint until `lastRefreshedAt` moves or `refresh.pending` clears. Needs the `ViewProfile` permission.
Refresh a profile POST
Queues one request at the 'opened in Modbot' tier, behind only people seen in an instance right now. Answers immediately; the refresh happens on the users lane at its own pace. A profile fetched within the fresh-enough gap is not queued again, so a screen may call this on every open without spending the lane. Needs the `ViewProfile` permission.