Skip to content

Hydrate Historical Plays

POST
/api/components/{id}/plays/historical
curl --request POST \
--url https://example.com/api/components/example/plays/historical \
--header 'Content-Type: application/json' \
--cookie ms.session_token=<ms.session_token> \
--data '{ "type": "full" }'

If the Source/Client supports Historical Play capabilities, this route requests a manual hydration of historical Plays

id
required
string
Media typeapplication/json
object
type

Use full to initiate a complete sync of all history or recent to sync the last ~100 plays.

string
Allowed values: full recent

Success

The request failed validation

Media typeapplication/json

The request’s body, query or params didn’t match the route’s schema

object
error
required
string
Allowed value: Validation failed
details
required

What was wrong, one entry per problem

Array<object>
object
message
required
string
path

Where the problem is, e.g. [“amount”] or [“items”, 0, “id”]

Array

Example

{
"error": "Validation failed"
}