{"_id":"57fcc4870312b20e00ac6525","__v":0,"user":"54497cce27b7fc140078d9a5","version":{"_id":"57fcc4860312b20e00ac64c0","project":"5435687035740020002a1c04","__v":1,"createdAt":"2016-10-11T10:52:54.637Z","releaseDate":"2016-10-11T10:52:54.637Z","categories":["57fcc4860312b20e00ac64c1","57fcc4860312b20e00ac64c2","57fcc4860312b20e00ac64c3","57fcc4860312b20e00ac64c4","57fcc4860312b20e00ac64c5","57fcc4860312b20e00ac64c6","57fcc4860312b20e00ac64c7","57fcc4860312b20e00ac64c8","57fcc4860312b20e00ac64c9","57fcc4860312b20e00ac64ca","57fcc4860312b20e00ac64cb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"[APP-1265], [APP-1035]","version_clean":"5.2.0","version":"5.2"},"parentDoc":null,"project":"5435687035740020002a1c04","category":{"_id":"57fcc4860312b20e00ac64ca","version":"57fcc4860312b20e00ac64c0","__v":0,"project":"5435687035740020002a1c04","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-30T22:39:02.374Z","from_sync":false,"order":9,"slug":"flow-data-structures","title":"Flow Data Structures"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-31T23:15:05.799Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"name":"","code":"{\n    \"errors\": [\n    ],\n    \"skipped\": [\n    ],\n    \"updated\": [\n    \t\"your_flow_tag\"\n    ]\n}","language":"json"},{"name":"","code":"{\n    \"errors\": [\n        \"error description\"\n    ],\n    \"skipped\": [\n    \t\"your_flow_tag\"\n    ],\n    \"updated\": [\n    ]\n}","language":"json","status":400}]},"settings":"","examples":{"codes":[{"language":"lua","name":"Agent Lua","code":"output.mp4 = \"https://www.telemetryapp.com/video.mp4\""}]},"method":"post","auth":"required","params":[{"_id":"5682d99270331a0d00484a28","ref":"","in":"path","required":true,"desc":"The flow tag","default":"","type":"string","name":"video_flow_tag"},{"_id":"5682d99270331a0d00484a27","ref":"","in":"body","required":false,"desc":"The MP4 version of the video. At least one of WebM, Ogg or MP4 has to be present.","default":"","type":"string","name":"mp4"},{"_id":"5682d99270331a0d00484a26","ref":"","in":"body","required":false,"desc":"The Ogg (See http://xiph.org/ogg/ for more reference) version of the video. At least one of WebM, Ogg or MP4 has to be present.","default":"","type":"string","name":"ogg"},{"_id":"5682d99270331a0d00484a25","ref":"","in":"body","required":false,"desc":"The WebM (See http://www.webmproject.org/ for more reference) version of the video. At least one of WebM, Ogg or MP4 has to be present.","default":"","type":"string","name":"webm"},{"_id":"5682d99270331a0d00484a24","ref":"","in":"body","required":false,"desc":"An optional URL to the image poster.","default":"","type":"string","name":"poster"},{"_id":"5682d99270331a0d00484a23","ref":"","in":"body","required":false,"desc":"Whether the video should be muted or not.","default":"","type":"boolean","name":"muted"},{"_id":"5682d99270331a0d00484a22","ref":"","in":"body","required":false,"desc":"How the video should fit the container. One of: \"fit\", \"scale\", \"fill\"","default":"","type":"string","name":"mode"}],"url":"/flows/:video_flow_tag/metrics"},"isReference":false,"order":22,"body":"[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/0bS93chRzCLDXfLqM6qh_video.png\",\n        \"video.png\",\n        \"800\",\n        \"215\",\n        \"#5074b4\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"Video widget displays a video on your board. At least one of WebM, Ogg or MP4 has to be present.","slug":"video","type":"endpoint","title":"Video"}

postVideo

Video widget displays a video on your board. At least one of WebM, Ogg or MP4 has to be present.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

video_flow_tag:
required
string
The flow tag

Body Params

mp4:
string
The MP4 version of the video. At least one of WebM, Ogg or MP4 has to be present.
ogg:
string
The Ogg (See http://xiph.org/ogg/ for more reference) version of the video. At least one of WebM, Ogg or MP4 has to be present.
webm:
string
The WebM (See http://www.webmproject.org/ for more reference) version of the video. At least one of WebM, Ogg or MP4 has to be present.
poster:
string
An optional URL to the image poster.
muted:
boolean
Whether the video should be muted or not.
mode:
string
How the video should fit the container. One of: "fit", "scale", "fill"

Examples


Result Format


Documentation

[block:image] { "images": [ { "image": [ "https://files.readme.io/0bS93chRzCLDXfLqM6qh_video.png", "video.png", "800", "215", "#5074b4", "" ] } ] } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}