GET user/{userId}/progress/{key}

Related
GETPUT

Get a specific key-value pair of a user's progress data.

Example

GET /api/v1/user/66a5db1f-2785-498d-9068-e24ddbba03f2/progress/adventure HTTP/1.1
Authorization: Bearer ...
Accept: application/json
----------------------------------------
HTTP/1.1 200 OK
ETag: ...

{
  "key": "adventure",
  "value": { "some": "data" },
  "timestamp": 1554760285
}

Security

Authentication is required, and access is restricted to the user.

URL Parameters

NameDescriptionValue
userIdthe ID of the user as a GUID with dashesstring
keythe key of the key-value pair to returnstring

Request Body

NONE

Response

Successful responses are code 200 with data in the response body. Error responses are standard.

Response Body

NameDescriptionValue
keythe key of the progress datastring
valuethe data currently stored by the server at this keyobject
timestampthe timestamp the server's data was written; a Unix timestamp in secondsnumber