Reporting

The endpoint /Reporting provides the details to a specific job or to all jobs run in a given month as a JSON array.

note

This endpoint is considered deprecated, but it is supported for existing customers.

The returned data structure follows the definition below:

[
    {
        "AcquiredFilesSizeInBytes": 92377486,
        "PublishedFilesSizeInBytes": 50803418,
        "JobStartTime": "2020-05-26T07:25:44.193+00:00",
        "JobFinishedTime": "2020-05-26T07:36:43.964+00:00",
        "VideoFormat": 0,
        "ExtractedVideoDurationInSeconds": 30,
        "EncodedVideoDurationInSeconds": 30,
        "BitrateVariants": "4500,3000,2500,2000,1500",
        "BitratesCount": 5,
        "OutputFormat": "DASH",
        "EncodingOptimizedFor": 0,
        "Success": true,
        "Drm": false,
        "JobId": "13f7ddab-1329-41cb-a425-ce6a00972e46",
        "TenantId": "customer",
        "ExternalId": "",
        "ExternalType": "",
        "ExternalProvider": ""
    },
    ...
]

Here is a table with the reporting object properties description.

Property	Type	Description
AcquiredFilesSizeInBytes	long	Size of acquired source content in bytes.
PublishedFilesSizeInBytes	long	Total size of output produced and published by Axinom Encoding in bytes.
JobStartTime	string	Job processing start date and time.
JobFinishedTime	string	Job processing completion date and time.
VideoFormat	integer	Codec used. 0 stands for H.264 (AVC).
ExtractedVideoDurationInSeconds	integer	Duration of the source video extracted by Axinom Encoding.
EncodedVideoDurationInSeconds	integer	Duration of the video after encoding. Usually, it is the same as ExtractedVideoDurationInSeconds.
BitrateVariants	string	Comma separated list of produced bitrates, in KBps.
BitratesCount	integer	Number of produced BitrateVariants.
OutputFormat	string	Produced output format. Supported values: Dash, HLS, Both, CMAF, DashOnDemand. The option Both stands for Dash and HLS.
EncodingOptimizedFor	integer	Used the OptimizeFor option in job processing. Values: 0 = Speed, 1 = Balance, 2 = Quality.
Success	boolean	Job status.
Drm	boolean	Whether a job used DRM protection or not.
JobId	string	Job’s unique identifier.
TenantId	string	Name of the Tenant.
ExternalId	string	Custom external ID provided to a job.
ExternalType	string	Custom external type provided to a job.
ExternalProvider	string	Custom external provider provided to a job.

Authentication and Authorization

Only authenticated users can make requests to the Encoding API. There is only one possible way to authenticate yourself as a valid user of the Encoding Reporting Service.

Using Encoding Tenant and Management Key

If you created an Axinom Encoding Tenant in the old way (don’t confuse it with Mosaic Tenant), you get the following information:

• Axinom Encoding URL, e.g. "https://vip-eu-west-1.axinom.com"
• Tenant Name - human-readable name, e.g. "My Tenant"
• Management Key - a UUID, e.g. 8a276e90-6923-4bda-9f5e-8eddc9159a1e

Management Key shall be passed to each Encoding reporing API request inside an Authorization header:

Authorization: Tenant-Auth <MANAGEMENT_KEY>

Caution

It is not possible to recover the Management Key if it’s lost. It is possible to generate a new one by raising a ticket to Axinom Support.

In this authentication scheme there is no additional authorization. Every request with a valid Management Key will be granted access to the Encoding API.