Description: Retrieve PlayoutMetrics

URL: http://{your-server-url}/api/v1/appspace/playoutmetrics

Method: GET

Token Required: True

Request Headers:

content-type: application/json or content-type: application/xml
token: {token}

Required Roles:

Portal Administrator, Account Administrator, Account Owner, Content Administrator

Request Query Parameters:

Example: http://{your-server-url}/api/v1/appspace/playoutmetrics?page=string&startdate=string&enddate=string

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.PlayoutMetrics.PlayoutMetricsResponse

The following is an example response Xml body:

<PlayoutMetricsResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.PlayoutMetrics" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DebugMessage xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">String</DebugMessage>
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">
    <Error>
      <Code>String</Code>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <PlayoutContentAComponents>
    <Data>String</Data>
  </PlayoutContentAComponents>
  <PlayoutContentApplications>
    <Data>String</Data>
  </PlayoutContentApplications>
  <PlayoutContentMediaZones>
    <Data>String</Data>
  </PlayoutContentMediaZones>
  <PlayoutContentPlayers>
    <Data>String</Data>
  </PlayoutContentPlayers>
  <PlayoutContentSchedules>
    <Data>String</Data>
  </PlayoutContentSchedules>
  <PlayoutContents>
    <Data>String</Data>
  </PlayoutContents>
  <PlayoutMetrics>
    <Data>String</Data>
    <PlayoutMetricsArray xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.PlayoutMetrics">
      <a:PlayoutMetric>
        <a:ApplicationId>123</a:ApplicationId>
        <a:ComponentId>123</a:ComponentId>
        <a:ContentId>123</a:ContentId>
        <a:FullPlayout>true</a:FullPlayout>
        <a:Id>123</a:Id>
        <a:MediaZoneId>123</a:MediaZoneId>
        <a:PlayerId>123</a:PlayerId>
        <a:PlayoutEnd>2014-04-24T17:53:43.2152142Z</a:PlayoutEnd>
        <a:PlayoutStart>2014-04-24T17:53:43.2152142Z</a:PlayoutStart>
        <a:ScheduleId>123</a:ScheduleId>
        <a:Type>VideoWall</a:Type>
      </a:PlayoutMetric>
    </PlayoutMetricsArray>
  </PlayoutMetrics>
</PlayoutMetricsResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"PlayoutContentAComponents":{
		"Data":"String"
	},
	"PlayoutContentApplications":{
		"Data":"String"
	},
	"PlayoutContentMediaZones":{
		"Data":"String"
	},
	"PlayoutContentPlayers":{
		"Data":"String"
	},
	"PlayoutContentSchedules":{
		"Data":"String"
	},
	"PlayoutContents":{
		"Data":"String"
	},
	"PlayoutMetrics":{
		"Data":"String",
		"PlayoutMetricsArray":[
			{
				"ApplicationId":123,
				"ComponentId":123,
				"ContentId":123,
				"FullPlayout":true,
				"Id":123,
				"MediaZoneId":123,
				"PlayerId":123,
				"PlayoutEnd":"\/Date(1398362023215)\/",
				"PlayoutStart":"\/Date(1398362023215)\/",
				"ScheduleId":123,
				"Type":3
			}
		]
	}
}