Endpointpost /v3/scanVideo
Parameters
| data string, required |
The complete video in base64-encoded format. This payload may be up to 500 MB. |
| spec_id int, optional |
The ID of an ad specification set against which you want to validate the creative. Defaults to 0 (IAB guidelines). |
| workspace_id int, optional |
The ID of the workspace in which you want to store the results. |
| name string, optional |
The file name of the video. Will be added to the JSON result, allowing you to keep track of which video you scanned. |
Response200 400 401 429
| audio_wave array |
An object containing an image of the audio wave of the video.
|
| film_strip array |
An object containing an image of multiple video shots taken at regular intervals.
|
| info array |
An array with data points collected from the video. See the response object for more details.
audio - bit rate, audio codec, loudness in LUFS, etc.
container - the container format (like MPEG), file size, MOOV atom positions, etc.
video - aspect ratio, dimensions, bit rate, etc.
|
| job_id string |
A unique ID assigned to the scan.
|
| meta array |
Meta-data about the scan, like the CPU used, the time it took to complete the scan, the server location, etc.
|
| name string |
The name of the creative (copied from the payload).
|
| tips_and_updatesscan_results object |
An object containing the full scan results, including the number of passed/failed tests.
The tests array contains the result of each test performed.
|
| screenshot array |
A screenshot/poster of the video, in both high-res and thumbnail format. The url points to the location where the screenshot can be found.
|
| video array |
An array with information about the video file, including the URL from where you can download the original video.
|
|
cURL
curl "https://{your_name}.api.advalify.io/v3/scanVideo"
-H "X-ApiKey: TCm2Hd_rT4pRNvSZ2cGYCJ6... (example)"
-X POST
-d '{
"data": "dGhpcyBpcyBzb21lIHZpZGVvIGRhdGE..."
}'
Example Response
{
"audio_wave": {
"bytes": 5972,
"color": "#e0e0e0",
"mime_type": "image/png",
"url": "https://try.cdn.advalify.io/img/9k30d-79707058-54ad6e51-c2450-81e0a-ae2fa-xc7sgwhn.png"
},
"film_strip": {
"bytes": 23981,
"mime_type": "image/jpg",
"url": "https://try.cdn.advalify.io/img/9k30d-79707058-54ad6e51-c2450-81e0a-ae2fa-k9gqz8f2.jpg"
},
"info": {
"audio": {
"bit_rate": 192,
"channels": 2,
"codec": "AAC",
"compression": "lossy",
"loudness": {
"lra": 16.2,
"lufs": -23.1,
"true_peak": -12
},
"sample_rate": 48
},
"container": {
"atoms": {
"moov_position": "beginning",
"order": "ftyp,moov,mvhd,trak,tkhd,mdia,mdhd,hdlr,minf,dinf,dref,stbl,stsd,avc1,avcC,stts,stsc,stco,stsz,stss,vmhd,trak,tkhd,mdia,mdhd,hdlr,minf,dinf,dref,stbl,stsd,mp4a,esds,stts,stsc,stco,stsz,smhd,udta,meta,hdlr,ilst,data,gsst,data,gstd,data,mdat"
},
"bit_rate": 912,
"bit_rate_mode": "Variable",
"duration": 30,
"file_extension": "mp4",
"file_size": 3423521,
"format": "MPEG-4",
"mime_type": "video/mp4"
},
"video": {
"aspect_ratio": "16:9",
"bit_depth": 8,
"bit_rate": 718,
"chroma_subsampling": "4:2:0",
"codec": "H.264",
"color_space": "YUV",
"definition": "",
"dimensions": "854x480",
"frame_rate": 25,
"height": 480,
"letterboxing": false,
"scan_type": "progressive",
"width": 854
}
},
"job_id": "c2450-81e0a-ae2fa",
"meta": {
"api_version": "v3",
"cpu": "AMD 16-Core EPYC 7302P",
"creative_type": "video",
"ram": "128GB",
"scan_duration": "1.010519",
"server_location": "ams",
"timestamp": 1652869385,
"duration": "1.207079"
},
"name": "video_name.mp4",
"scan_results": {
"failed": 2,
"passed": 19,
"report_url": "https://share.advalify.io/c2450-f8e87-71c8a-bf12f",
"tests": {
"audio_loudness": {
"actual": -23.9,
"data_type": "float",
"expected": "-26#-22",
"expected_text": "between -26 and -22 LUFS",
"name": "Audio Loudness",
"operator": "><",
"result": "passed",
"unit": "LUFS"
},
}
},
"screenshot": {
"highres": {
"bytes": 18438,
"mime_type": "image/jpg",
"url": "https://try.cdn.advalify.io/img/9k30d-79707058-54ad6e51-c2450-81e0a-ae2fa-6ndqprb2.jpg"
},
"thumbnail": {
"bytes": 1634,
"color": "#27292d",
"height": 57,
"mime_type": "image/jpg",
"url": "https://try.cdn.advalify.io/img/9k30d-79707058-54ad6e51-c2450-81e0a-ae2fa-5csfh9m4.jpg",
"width": 100
}
},
"video": {
"bytes": 36415098,
"mime_type": "video/mp4",
"url": "https://try.cdn.advalify.io/img/9k30d-9k30d-9e62d-8b61e-ktjd3bgw.mp4"
}
}
|
