Initiate Logout initiate-logout

Endpoint

Called
By

Input
Params

HTTP
Method

Response

HTTP
Response

<SP_FQDN>/api/v1/logout

Streaming App

or

Programmer Service

1. requestor
2. deviceId (Mandatory)
3. device_info/X-Device-Info (Mandatory)
4. deviceType
5. deviceUser (Deprecated)
6. appId (Deprecated)

DELETE

None

204

Input Parameter

Description

requestor

The Programmer requestorId for which this operation is valid.

deviceId

The device id bytes.

device_info/

X-Device-Info

Streaming Device information.

Note: This MAY be passed device_info as a URL paramater, but due to the potential size of this paramater and limitations on the length of a GET URL, it SHOULD be passed as X-Device-Info n the http header.

See the full details in Passing Device and Connection Information.

The device type (e.g. Roku, PC).

If this parameter is set correctly, ESM offers metrics that are broken down per device type when using Clientless, so that different types of analysis can be performed for e.g. Roku, AppleTV, Xbox etc.

See Benefits of using the clientless device type parameter in pass metrics

Note: the device_info will replace this parameter.

The device user identifier.

Note: If used, deviceUser should have the same values as in the Create Registration Code request.

The application id/name.

Note: the device_info replaces this parameter. If used, appId should have the same values as in the Create Registration Code request.