This action allows you to retrieve statistics for job requests over a given range of dates.
Request
<?xml version="1.0"?>
<query>
<userid>[UserID]</userid> <!-- required-->
<userkey>[UserKey]</userkey> <!-- required-->
<action>GetQueueStats</action>
<mediaid>[MediaID]</mediaid> <!-- Optional -->
<date_from>[YYYY-MM-DD HH:MM:SS]</date_from> <!-- Optional -->
<date_to>[YYYY-MM-DD HH:MM:SS]</date_to> <!-- Optional -->
</query>
{
"query": {
"userid": "[UserID]",
"userkey": "[UserKey]",
"action": "GetQueueStats",
"mediaid": "[MediaID]",
"date_from": "[YYYY-MM-DD HH:MM:SS]",
"date_to": "[YYYY-MM-DD HH:MM:SS]"
}
}
Parameter | Description | Allowed Values | Default Value |
---|---|---|---|
mediaid | Specify the mediaIDs in a list. | Comma separated list. | None |
date_from | Specify the date range start date. | Valid date in format ‘YYYY-MM-DD HH:MM:SS’ | One month before <date_to> |
date_to | Specify the date range end date. | Valid date in format ‘YYYY-MM-DD HH:MM:SS’ | Up to current moment. |
Response
If is specified:
<?xml version="1.0"?>
<response>
<date_from>[Date Range Start]</date_from>
<date_to>[Date Range End]</date_to>
<media>
<id>[MediaID]</id>
<size>[Queue Size]</size>
<minimum>[Minimum Queue Time]</minimum>
<minimumSeconds>[Minimum Queue Time in seconds]</minimumSeconds>
<maximum>[Maximum Queue Time]</maximum>
<maximumSeconds>[Maximum Queue Time in seconds]</maximumSeconds>
<average>[Average Queue Time]</average>
<averageSeconds>[Average Queue Time in seconds]</averageSeconds>
</media>
<media>
<!-- Media list -->
</media>
</response>
{
"response": {
"date_from": "[Date Range Start]",
"date_to": "[Date Range End]",
"media": [
{
"id": "[MediaID]",
"size": "[Queue Size]",
"minimum": "[Minimum Queue Time]",
"minimumSeconds": "[Minimum Queue Time in seconds]",
"maximum": "[Maximum Queue Time]",
"maximumSeconds": "[Maximum Queue Time in seconds]",
"average": "[Average Queue Time]",
"averageSeconds": "[Average Queue Time in seconds]"
}
]
}
}
If is NOT specified:
<?xml version="1.0"?>
<response>
<date_from>[Date Range Start]</date_from>
<date_to>[Date Range End]</date_to>
<media>
<id>[MediaIDs comma separated list]</id>
<size>[Queue Size]</size>
<minimum>[Minimum Queue Time]</minimum>
<minimumSeconds>[Minimum Queue Time in seconds]</minimumSeconds>
<maximum>[Maximum Queue Time]</maximum>
<maximumSeconds>[Maximum Queue Time in seconds]</maximumSeconds>
<average>[Average Queue Time]</average>
<averageSeconds>[Average Queue Time in seconds]</averageSeconds>
</media>
</response>
{
"response": {
"date_from": "[Date Range Start]",
"date_to": "[Date Range End]",
"media": {
"id": "[MediaIDs comma separated list]",
"size": "[Queue Size]",
"minimum": "[Minimum Queue Time]",
"minimumSeconds": "[Minimum Queue Time in seconds]",
"maximum": "[Maximum Queue Time]",
"maximumSeconds": "[Maximum Queue Time in seconds]",
"average": "[Average Queue Time]",
"averageSeconds": "[Average Queue Time in seconds]"
}
}
}