logo
API docs by Redocly

Metrics

Download OpenAPI specification:

URL: https://veset.tv/ Terms of Service

Services

Ingest - Library - Channel - Schedule - Playout - Audit - Accounts - Reporting - Monitoring - Configuration - Metrics

Playout usage

Playout usage

Get cache download metrics

Get cache download metrics

query Parameters
organization
required
string
Request Body schema: application/json
required
from
required
string <date-time>
period
integer <int32>
periodType
string
Enum: "MINUTES" "DAYS" "HOURS"
playoutIds
Array of strings
to
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "period": 0,
  • "periodType": "MINUTES",
  • "playoutIds": [
    ],
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get playout historical data

Get playout historical data

query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
channelIds
Array of strings
from
required
string <date-time>
includeData
Array of strings
period
integer <int32>
periodType
string
Enum: "MINUTES" "DAYS" "HOURS"
playoutIds
Array of strings
to
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "channelIds": [
    ],
  • "from": "2019-08-24T14:15:22Z",
  • "includeData": [
    ],
  • "period": 0,
  • "periodType": "MINUTES",
  • "playoutIds": [
    ],
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get playout historical data groups

Get playout historical data groups

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get playout licence usage summary

Get playout licence usage summary

query Parameters
organization
required
string
Request Body schema: application/json
required
from
required
string <date-time>
period
integer <int32>
periodType
string
Enum: "MINUTES" "DAYS" "HOURS"
playoutIds
Array of strings
to
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "period": 0,
  • "periodType": "MINUTES",
  • "playoutIds": [
    ],
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get playout usage summary

Get playout usage summary

query Parameters
organization
required
string
Request Body schema: application/json
required
from
required
string <date-time>
period
integer <int32>
periodType
string
Enum: "MINUTES" "DAYS" "HOURS"
playoutIds
Array of strings
to
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "period": 0,
  • "periodType": "MINUTES",
  • "playoutIds": [
    ],
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
[
  • {
    }
]

Recalculate playout usage summary

Recalculate playout usage summary

query Parameters
startDate
required
string <date-time>

Responses

Response samples

Content type
application/json
{ }

Get playout uptime summary

Get playout uptime summary

query Parameters
organization
Array of strings
Request Body schema: application/json
required
from
required
string <date-time>
period
integer <int32>
periodType
string
Enum: "MINUTES" "DAYS" "HOURS"
playoutIds
Array of strings
to
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "period": 0,
  • "periodType": "MINUTES",
  • "playoutIds": [
    ],
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get unique playout names by ip

Get unique playout names by ip

path Parameters
ip
required
string
query Parameters
organization
required
string
Request Body schema: application/json
required
from
required
string <date-time>
period
integer <int32>
periodType
string
Enum: "MINUTES" "DAYS" "HOURS"
playoutIds
Array of strings
to
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "period": 0,
  • "periodType": "MINUTES",
  • "playoutIds": [
    ],
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
[
  • "string"
]

Get playout uptime data

Get playout uptime data

path Parameters
playoutId
required
string
query Parameters
organization
string

Responses

Response samples

Content type
application/json
{
  • "organization": "string",
  • "playoutId": "string",
  • "totalDowntime": 0,
  • "totalUptime": 0
}

Ingest usage

Ingest usage

Get ingest load metrics

query Parameters
region
string
type
string
Default: "S3"
Enum: "S3" "BRIGHTCOVE" "FTP" "SERVERS_COM" "TELIA_S3" "ALIBABA" "S3_GENERIC" "AZURE" "WASABI" "S3_PAIRED" "S3_EXTERNAL" "DOTSTUDIO_PRO"

Responses

Response samples

Content type
application/json
{ }

Get ingest metrics

query Parameters
organization
required
string
Request Body schema: application/json
required
from
required
string <date-time>
period
integer <int32>
periodType
string
Enum: "MINUTES" "DAYS" "HOURS"
playoutIds
Array of strings
to
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "period": 0,
  • "periodType": "MINUTES",
  • "playoutIds": [
    ],
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{ }

Get ingest queue history

Request Body schema: application/json
required
from
required
string <date-time>
period
integer <int32>
periodType
string
Enum: "MINUTES" "DAYS" "HOURS"
playoutIds
Array of strings
to
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "period": 0,
  • "periodType": "MINUTES",
  • "playoutIds": [
    ],
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{ }

Get ingest queue summary

Responses

Response samples

Content type
application/json
{ }

Mediastore metrics

Mediastore metrics

getMediaStoreMetrics_1

query Parameters
organization
required
string
Request Body schema: application/json
required
from
required
string <date-time>
period
integer <int32>
periodType
string
Enum: "MINUTES" "DAYS" "HOURS"
playoutIds
Array of strings
to
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "period": 0,
  • "periodType": "MINUTES",
  • "playoutIds": [
    ],
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
[
  • {
    }
]

Cluster metrics

Cluster metrics

Get cluster info

Responses

Response samples

Content type
application/json
{ }

Get performance metrics

query Parameters
from
required
string <date-time>
to
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Save performance metric data

path Parameters
executionId
required
string
Request Body schema: application/json
required
duration
integer <int64>
executionTime
string <date-time>
success
boolean
type
string

Responses

Request samples

Content type
application/json
{
  • "duration": 0,
  • "executionTime": "2019-08-24T14:15:22Z",
  • "success": true,
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get preview statistics

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Marketplace metrics

Marketplace metrics

Retrieve organization usage

Request Body schema: application/json
required
from
required
string <date-time>
period
integer <int32>
periodType
string
Enum: "MINUTES" "DAYS" "HOURS"
playoutIds
Array of strings
to
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "period": 0,
  • "periodType": "MINUTES",
  • "playoutIds": [
    ],
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
[
  • {
    }
]

getMarketplaceOrganizations

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Organization usage

Organization usage

Get channel uptime

query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
channelIds
Array of strings
from
required
string <date-time>
includeData
Array of strings
period
integer <int32>
periodType
string
Enum: "MINUTES" "DAYS" "HOURS"
playoutIds
Array of strings
to
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "channelIds": [
    ],
  • "from": "2019-08-24T14:15:22Z",
  • "includeData": [
    ],
  • "period": 0,
  • "periodType": "MINUTES",
  • "playoutIds": [
    ],
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get organizations usage

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

Get organization playout summary

path Parameters
organization
required
string
Request Body schema: application/json
required
from
required
string <date-time>
period
integer <int32>
periodType
string
Enum: "MINUTES" "DAYS" "HOURS"
playoutIds
Array of strings
to
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "period": 0,
  • "periodType": "MINUTES",
  • "playoutIds": [
    ],
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "activeOnPeriodEnd": 0,
  • "activeOnPeriodStart": 0,
  • "inActiveOnPeriodEnd": 0,
  • "inActiveOnPeriodStart": 0,
  • "totalDowntime": 0,
  • "totalUptime": 0
}

Get organization usage

path Parameters
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "cloudPlayouts": 0,
  • "id": "string",
  • "ingestUsageInfo": {
    },
  • "mediaStoreUsage": {
    },
  • "organizationCreateDate": "2019-08-24T14:15:22Z",
  • "organizationId": "string",
  • "organizationName": "string",
  • "playoutSummary": {
    },
  • "totalAccounts": 0,
  • "totalPlayouts": 0
}