{"_id":"57fcc4870312b20e00ac6516","parentDoc":null,"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"},"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"},"user":"54497cce27b7fc140078d9a5","__v":0,"project":"5435687035740020002a1c04","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-31T23:07:12.999Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n    \"errors\": [\n    ],\n    \"skipped\": [\n    ],\n    \"updated\": [\n    \t\"your_flow_tag\"\n    ]\n}"},{"code":"{\n    \"errors\": [\n        \"error description\"\n    ],\n    \"skipped\": [\n    \t\"your_flow_tag\"\n    ],\n    \"updated\": [\n    ]\n}","language":"json","status":400,"name":""}]},"settings":"","examples":{"codes":[{"code":"output.url = \"https://www.telemetryapp.com\"","language":"lua","name":"Agent Lua"}]},"auth":"required","params":[{"_id":"567b1e16b56bac0d0019d8a3","ref":"","in":"path","required":true,"desc":"The flow tag","default":"","type":"string","name":"iframe_flow_tag"},{"_id":"567b1e16b56bac0d0019d8a2","ref":"","in":"body","required":true,"desc":"The URL of the iframe.","default":"","type":"string","name":"url"},{"_id":"567b1e16b56bac0d0019d8a1","ref":"","in":"body","required":false,"desc":"Whether to allow scrolling when the content is larger than the iframe itself.","default":"","type":"boolean","name":"scrolling"}],"url":"/flows/:iframe_flow_tag/metrics"},"isReference":false,"order":7,"body":"[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/fLmnEkF8TcOyym7UF0cE_iframe.png\",\n        \"iframe.png\",\n        \"800\",\n        \"215\",\n        \"#d7621e\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"iFrames are web pages included within a web page. As such they may contain any data.","slug":"iframe","type":"endpoint","title":"iFrame"}

postiFrame

iFrames are web pages included within a web page. As such they may contain any data.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

iframe_flow_tag:
required
string
The flow tag

Body Params

url:
required
string
The URL of the iframe.
scrolling:
boolean
Whether to allow scrolling when the content is larger than the iframe itself.

Examples


Result Format


Documentation

[block:image] { "images": [ { "image": [ "https://files.readme.io/fLmnEkF8TcOyym7UF0cE_iframe.png", "iframe.png", "800", "215", "#d7621e", "" ] } ] } [/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 }}