Skip to content

Episodes_MarkEpisodeViewed

POST
/v1/accounts/{account}/datasets/{dataset}/episodes/{episode}:markViewed
curl --request POST \
--url https://junction-api.qualiastudios.dev/v1/accounts/example/datasets/example/episodes/example:markViewed \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "name": "example" }'

Records that the caller opened an episode. Idempotent. Viewed is kept per person, so an API key gets FAILED_PRECONDITION.

account
required
string

The account id.

dataset
required
string

The dataset id.

episode
required
string

The episode id.

Media type application/json

Request for Episodes.MarkEpisodeViewed.

object
name
required

Accounts/{account}/datasets/{dataset}/episodes/{episode}

string
Example generated
{
"name": "example"
}

OK

Media type application/json

Response for Episodes.MarkEpisodeViewed.

object
Example generated
{}

Default error response

Media type application/json
One of:
API error

A refusal from the API itself.

object
code
required

The gRPC code name in upper case, e.g. NOT_FOUND.

string
message
required
string
retryable
required

Whether the same call may succeed if retried.

boolean
details
required

Empty, except when a dataset copy or move is refused: then one google.rpc.ErrorInfo with the refusal’s reason code, its domain and, in metadata, the datasets it names.

Array<object>
object
Example generated
{
"code": "example",
"message": "example",
"retryable": true,
"details": [
{}
]
}