Get
/api/mediaplayed/summarized/{externalPlayerId}/{date}
Security
OAuth
Authorization using OAuth2 with Client Credentials
FlowClient Credentials
Authorization URLhttps://identity.eu01.grassfish.com/connect/authorize
Token URLhttps://identity.eu01.grassfish.com/connect/token
Header parameters
x-correlationToken
string
x-clientId
string
x-onBehalfOf
string
x-usePlayerCode
boolean
api-version
string
Path parameters
externalPlayerId
stringRequired
date
string (date) Required
Responses
200
OK
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[
"InvalidDatePeriodEndDateBeforeStartDate",
"NameAlreadyTaken",
"ExternalIdAlreadyTaken",
"CodeAlreadyTaken"
]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
player
object (Contracts.Connect.Results.Media.MediaPlayedPlayerJson)
id
string | null
name
string | null
code
string | null
locationId
string | null
locationName
string | null
locationCode
string | null
macAddress
string | null
firstTimestamp
string (date-time) | null
lastTimestamp
string (date-time) | null
mediaPlayedSummary
Array of object (Contracts.Connect.Results.Media.MediaPlayedMediaSummaryJson) | null
object
id
string | null
name
string | null
code
string | null
library
string
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
mediaType
string
Valid values[
"None",
"Audio",
"Video",
"Photo",
"Text",
"HtmlSign",
"Json",
"HtmlTemplate",
"WebPage",
"File"
]
playbackCount
number (double)
totalDurationSeconds
number (double)
mediaPlayedByBroadcastGroupSummary
Array of object (Contracts.Connect.Results.Media.MediaPlayedBroadcastGroupSummaryJson) | null
object
broadcastCode
string | null
broadcastName
string | null
broadcastGroupCode
string | null
broadcastGroupName
string | null
spotLengthSeconds
number (double) | null
contentTypes
Array of string | null
string
mediaPlayedSummary
Array of object (Contracts.Connect.Results.Media.MediaPlayedMediaSummaryJson) | null
object
id
string | null
name
string | null
code
string | null
library
string
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
mediaType
string
Valid values[
"None",
"Audio",
"Video",
"Photo",
"Text",
"HtmlSign",
"Json",
"HtmlTemplate",
"WebPage",
"File"
]
playbackCount
number (double)
totalDurationSeconds
number (double)
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[
"InvalidDatePeriodEndDateBeforeStartDate",
"NameAlreadyTaken",
"ExternalIdAlreadyTaken",
"CodeAlreadyTaken"
]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
player
object (Contracts.Connect.Results.Media.MediaPlayedPlayerJson)
id
string | null
name
string | null
code
string | null
locationId
string | null
locationName
string | null
locationCode
string | null
macAddress
string | null
firstTimestamp
string (date-time) | null
lastTimestamp
string (date-time) | null
mediaPlayedSummary
Array of object (Contracts.Connect.Results.Media.MediaPlayedMediaSummaryJson) | null
object
id
string | null
name
string | null
code
string | null
library
string
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
mediaType
string
Valid values[
"None",
"Audio",
"Video",
"Photo",
"Text",
"HtmlSign",
"Json",
"HtmlTemplate",
"WebPage",
"File"
]
playbackCount
number (double)
totalDurationSeconds
number (double)
mediaPlayedByBroadcastGroupSummary
Array of object (Contracts.Connect.Results.Media.MediaPlayedBroadcastGroupSummaryJson) | null
object
broadcastCode
string | null
broadcastName
string | null
broadcastGroupCode
string | null
broadcastGroupName
string | null
spotLengthSeconds
number (double) | null
contentTypes
Array of string | null
string
mediaPlayedSummary
Array of object (Contracts.Connect.Results.Media.MediaPlayedMediaSummaryJson) | null
object
id
string | null
name
string | null
code
string | null
library
string
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
mediaType
string
Valid values[
"None",
"Audio",
"Video",
"Photo",
"Text",
"HtmlSign",
"Json",
"HtmlTemplate",
"WebPage",
"File"
]
playbackCount
number (double)
totalDurationSeconds
number (double)
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[
"InvalidDatePeriodEndDateBeforeStartDate",
"NameAlreadyTaken",
"ExternalIdAlreadyTaken",
"CodeAlreadyTaken"
]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
player
object (Contracts.Connect.Results.Media.MediaPlayedPlayerJson)
id
string | null
name
string | null
code
string | null
locationId
string | null
locationName
string | null
locationCode
string | null
macAddress
string | null
firstTimestamp
string (date-time) | null
lastTimestamp
string (date-time) | null
mediaPlayedSummary
Array of object (Contracts.Connect.Results.Media.MediaPlayedMediaSummaryJson) | null
object
id
string | null
name
string | null
code
string | null
library
string
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
mediaType
string
Valid values[
"None",
"Audio",
"Video",
"Photo",
"Text",
"HtmlSign",
"Json",
"HtmlTemplate",
"WebPage",
"File"
]
playbackCount
number (double)
totalDurationSeconds
number (double)
mediaPlayedByBroadcastGroupSummary
Array of object (Contracts.Connect.Results.Media.MediaPlayedBroadcastGroupSummaryJson) | null
object
broadcastCode
string | null
broadcastName
string | null
broadcastGroupCode
string | null
broadcastGroupName
string | null
spotLengthSeconds
number (double) | null
contentTypes
Array of string | null
string
mediaPlayedSummary
Array of object (Contracts.Connect.Results.Media.MediaPlayedMediaSummaryJson) | null
object
id
string | null
name
string | null
code
string | null
library
string
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
mediaType
string
Valid values[
"None",
"Audio",
"Video",
"Photo",
"Text",
"HtmlSign",
"Json",
"HtmlTemplate",
"WebPage",
"File"
]
playbackCount
number (double)
totalDurationSeconds
number (double)
400
Bad Request
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
401
Unauthorized
403
Forbidden
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
500
Internal Server Error