logo
API docs by Redocly

Reporting

Download OpenAPI specification:

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

Services

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

Jobs

Jobs API

Get jobs

Returns an aggregated list of async jobs for given user and organization

query Parameters
organization
Array of strings

Organization Id

providerId
string

Service Provider Id

status
Array of strings
Items Enum: "PENDING" "PROCESSING" "SUCCEEDED" "FAILED" "CANCELED"

Job status filter

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get job

Returns queued job

path Parameters
jobId
required
string

Job id

query Parameters
organization
Array of strings

Organization Id

providerId
string

providerId Id

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Get job file

Download a file associated with job

path Parameters
jobId
required
string

Job id

query Parameters
jobType
string

Job type

organization
Array of strings

Organization Id

providerId
string

Service Provider Id

Responses

Response samples

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

Reporting

Reporting API

Generate reports

Report generation job ID

query Parameters
providerId
string

Service Provider Id

Request Body schema: application/json
required
channelIds
Array of strings unique
from
string <date-time>
includeData
Array of strings unique
modules
Array of strings unique
Items Enum: "INGEST" "STORAGE" "CACHING" "PLAYOUT" "PLAYOUT_SUMMARY" "PLAYOUT_LICENCE" "PLAYOUT_HISTORICAL_DATA" "CHANNEL_UPTIME" "MP_SUBSCRIBER_REPORT"
organizations
Array of strings unique
period
integer <int32>
periodType
string
Enum: "MINUTES" "DAYS" "HOURS"
playoutIds
Array of strings unique
timezone
string
to
string <date-time>

Responses

Request samples

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

Response samples

Content type
application/json
{ }