{"_id":"57fcc4870312b20e00ac651b","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"},"project":"5435687035740020002a1c04","__v":0,"user":"54497cce27b7fc140078d9a5","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-31T23:09:21.976Z","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"},{"language":"json","status":400,"name":"","code":"{\n    \"errors\": [\n        \"error description\"\n    ],\n    \"skipped\": [\n    \t\"your_flow_tag\"\n    ],\n    \"updated\": [\n    ]\n}"}]},"settings":"","examples":{"codes":[{"code":"output.coords = {}\noutput.coords.lat = 49.2823587\noutput.coords.lon = -123.1213663\noutput.coords.zoom = 14","language":"lua","name":"Agent Lua"}]},"method":"post","auth":"required","params":[{"_id":"567b2433ee052b1700dbd9c2","ref":"","in":"path","required":true,"desc":"The flow tag","default":"","type":"string","name":"map_flow_tag"},{"_id":"567b2433ee052b1700dbd9c1","ref":"","in":"body","required":true,"desc":"Latitude of map center","default":"","type":"double","name":"coords.lat"},{"_id":"567b2433ee052b1700dbd9c0","ref":"","in":"body","required":true,"desc":"Longitude of map center","default":"","type":"double","name":"coords.lon"},{"_id":"567b2433ee052b1700dbd9bf","ref":"","in":"body","required":true,"desc":"Zoom level of map","default":"","type":"double","name":"coords.zoom"},{"_id":"567b2433ee052b1700dbd9be","ref":"","in":"body","required":false,"desc":"The type of the base map layer, one of: \"satellite\", \"light\", \"dark\"","default":"","type":"string","name":"type"},{"_id":"567b2433ee052b1700dbd9bd","ref":"","in":"body","required":false,"desc":"Use your own mapbox map for the base layer map.","default":"","type":"string","name":"mapbox_id"},{"_id":"567b2433ee052b1700dbd9bc","ref":"","in":"body","required":false,"desc":"An array of Circles objects, see below","default":"","type":"array_object","name":"circles"},{"_id":"567b2433ee052b1700dbd9bb","ref":"","in":"body","required":false,"desc":"An array of Markers objects, see below","default":"","type":"string","name":"markers"},{"_id":"567b2433ee052b1700dbd9ba","ref":"","in":"body","required":false,"desc":"An array of Polylines objects, see below","default":"","type":"string","name":"polylines"}],"url":"/flows/:map_flow_tag/metrics"},"isReference":false,"order":12,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Required\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Description\",\n    \"0-2\": \"object\",\n    \"0-3\": \"The coordinates of the center of the circle. It's in the form of {\\\"lat\\\": <latitude>, \\\"lon\\\": <longitude>}\",\n    \"1-3\": \"Latitude.\",\n    \"2-3\": \"Longitude.\",\n    \"2-2\": \"number, min = -180, max = 180\",\n    \"1-2\": \"number, min = -90, max = 90\",\n    \"3-3\": \"The fill color.\",\n    \"4-3\": \"The label of the circle.\",\n    \"5-3\": \"The width of the line.\",\n    \"6-3\": \"The radius of the circle.\",\n    \"7-3\": \"The color of the lines.\",\n    \"7-2\": \"CSS color\",\n    \"6-2\": \"number\",\n    \"5-2\": \"number\",\n    \"4-2\": \"string\",\n    \"3-2\": \"CSS color\",\n    \"0-0\": \"circles[]center\",\n    \"1-0\": \"circles[]center.lat\",\n    \"2-0\": \"circles[]center.lon\",\n    \"3-0\": \"circles[]fill_color\",\n    \"4-0\": \"circles[]label\",\n    \"5-0\": \"circles[]line_width\",\n    \"0-1\": \"Required\",\n    \"1-1\": \"Required\",\n    \"2-1\": \"Required\",\n    \"5-1\": \"Required\",\n    \"6-1\": \"Required\",\n    \"7-1\": \"Required\",\n    \"6-0\": \"circles[]radius\",\n    \"7-0\": \"circles[]stroke_color\",\n    \"8-0\": \"markers[]color\",\n    \"8-1\": \"Required\",\n    \"8-3\": \"The color of the marker.\",\n    \"8-2\": \"CSS color\",\n    \"9-3\": \"The coordinates of the marker. It's in the form of {\\\"lat\\\": <latitude>, \\\"lon\\\": <longitude>}.\",\n    \"9-2\": \"object\",\n    \"9-1\": \"Required\",\n    \"10-1\": \"Required\",\n    \"11-1\": \"Required\",\n    \"12-1\": \"Required\",\n    \"9-0\": \"markers[]coords\",\n    \"10-0\": \"markers[]coords.lat\",\n    \"11-0\": \"markers[]coords.lon\",\n    \"12-0\": \"markers[]icon\",\n    \"10-2\": \"number, min = -90, max = 90\",\n    \"11-2\": \"number, min = -180, max = 180\",\n    \"12-2\": \"string\",\n    \"12-3\": \"The icon of the marker. Must be the name of an icon from the Font Awesome (http://fortawesome.github.com/Font-Awesome/) library of icons.\",\n    \"11-3\": \"Longitude.\",\n    \"10-3\": \"Latitude.\",\n    \"13-3\": \"The label of the marker.\",\n    \"13-2\": \"string\",\n    \"13-0\": \"markers[]label\",\n    \"14-0\": \"polygons[]fill_color\",\n    \"15-0\": \"polygons[]label\",\n    \"16-0\": \"polygons[]line_width\",\n    \"17-0\": \"polygons[]stroke_color\",\n    \"18-0\": \"polygons[]vertices\",\n    \"19-0\": \"polygons[]vertices.lat\",\n    \"20-0\": \"polygons[]vertices.lon\",\n    \"14-1\": \"Required\",\n    \"16-1\": \"Required\",\n    \"17-1\": \"Required\",\n    \"18-1\": \"Required\",\n    \"19-1\": \"Required\",\n    \"20-1\": \"Required\",\n    \"22-1\": \"Required\",\n    \"23-1\": \"Required\",\n    \"24-1\": \"Required\",\n    \"25-1\": \"Required\",\n    \"26-1\": \"Required\",\n    \"26-0\": \"polylines[]vertices.lon\",\n    \"25-0\": \"polylines[]vertices.lat\",\n    \"24-0\": \"polylines[]vertices\",\n    \"23-0\": \"polylines[]stroke_color\",\n    \"22-0\": \"polylines[]line_width\",\n    \"21-0\": \"polylines[]label\",\n    \"26-2\": \"number, min = -180, max = 180\",\n    \"26-3\": \"Longitude.\",\n    \"25-3\": \"Latitude.\",\n    \"25-2\": \"number, min = -90, max = 90\",\n    \"24-2\": \"array of objects, min items = 2, max items = 20\",\n    \"24-3\": \"The coordinates of the vertices of the lines. It's in the form of [{\\\"lat\\\": <latitude 1>, \\\"lon\\\": <longitude 1>}, ...].\",\n    \"23-3\": \"The color of the lines.\",\n    \"23-2\": \"CSS color\",\n    \"22-2\": \"number\",\n    \"22-3\": \"The width of the lines.\",\n    \"21-3\": \"The label of the polyline.\",\n    \"21-2\": \"string\",\n    \"20-2\": \"number, min = -180, max = 180\",\n    \"20-3\": \"Longitude.\",\n    \"19-3\": \"Latitude.\",\n    \"19-2\": \"number, min = -90, max = 90\",\n    \"18-3\": \"The coordinates of the vertices of the polygon. It's in the form of [{\\\"lat\\\": <latitude 1>, \\\"lon\\\": <longitude 1>}, ...].\",\n    \"18-2\": \"array of objects, min items = 3, max items = 20\",\n    \"17-3\": \"The color of the lines.\",\n    \"17-2\": \"The color of the lines.\",\n    \"16-3\": \"The width of the lines.\",\n    \"16-2\": \"number\",\n    \"15-2\": \"string\",\n    \"15-3\": \"The label of the polygon.\",\n    \"14-3\": \"The fill color.\",\n    \"14-2\": \"CSS color\"\n  },\n  \"cols\": 4,\n  \"rows\": 27\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/vcaz7nAbSJysOaPvJq2a_map.png\",\n        \"map.png\",\n        \"800\",\n        \"215\",\n        \"#5c93ad\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"Map widget displays a map on your board using Mapbox (https://www.mapbox.com/).","slug":"map","type":"endpoint","title":"Map"}

postMap

Map widget displays a map on your board using Mapbox (https://www.mapbox.com/).

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

map_flow_tag:
required
string
The flow tag

Body Params

coords.lat:
required
double
Latitude of map center
coords.lon:
required
double
Longitude of map center
coords.zoom:
required
double
Zoom level of map
type:
string
The type of the base map layer, one of: "satellite", "light", "dark"
mapbox_id:
string
Use your own mapbox map for the base layer map.
circles:
array of objects
An array of Circles objects, see below
markers:
string
An array of Markers objects, see below
polylines:
string
An array of Polylines objects, see below

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Parameter", "h-1": "Required", "h-2": "Type", "h-3": "Description", "0-2": "object", "0-3": "The coordinates of the center of the circle. It's in the form of {\"lat\": <latitude>, \"lon\": <longitude>}", "1-3": "Latitude.", "2-3": "Longitude.", "2-2": "number, min = -180, max = 180", "1-2": "number, min = -90, max = 90", "3-3": "The fill color.", "4-3": "The label of the circle.", "5-3": "The width of the line.", "6-3": "The radius of the circle.", "7-3": "The color of the lines.", "7-2": "CSS color", "6-2": "number", "5-2": "number", "4-2": "string", "3-2": "CSS color", "0-0": "circles[]center", "1-0": "circles[]center.lat", "2-0": "circles[]center.lon", "3-0": "circles[]fill_color", "4-0": "circles[]label", "5-0": "circles[]line_width", "0-1": "Required", "1-1": "Required", "2-1": "Required", "5-1": "Required", "6-1": "Required", "7-1": "Required", "6-0": "circles[]radius", "7-0": "circles[]stroke_color", "8-0": "markers[]color", "8-1": "Required", "8-3": "The color of the marker.", "8-2": "CSS color", "9-3": "The coordinates of the marker. It's in the form of {\"lat\": <latitude>, \"lon\": <longitude>}.", "9-2": "object", "9-1": "Required", "10-1": "Required", "11-1": "Required", "12-1": "Required", "9-0": "markers[]coords", "10-0": "markers[]coords.lat", "11-0": "markers[]coords.lon", "12-0": "markers[]icon", "10-2": "number, min = -90, max = 90", "11-2": "number, min = -180, max = 180", "12-2": "string", "12-3": "The icon of the marker. Must be the name of an icon from the Font Awesome (http://fortawesome.github.com/Font-Awesome/) library of icons.", "11-3": "Longitude.", "10-3": "Latitude.", "13-3": "The label of the marker.", "13-2": "string", "13-0": "markers[]label", "14-0": "polygons[]fill_color", "15-0": "polygons[]label", "16-0": "polygons[]line_width", "17-0": "polygons[]stroke_color", "18-0": "polygons[]vertices", "19-0": "polygons[]vertices.lat", "20-0": "polygons[]vertices.lon", "14-1": "Required", "16-1": "Required", "17-1": "Required", "18-1": "Required", "19-1": "Required", "20-1": "Required", "22-1": "Required", "23-1": "Required", "24-1": "Required", "25-1": "Required", "26-1": "Required", "26-0": "polylines[]vertices.lon", "25-0": "polylines[]vertices.lat", "24-0": "polylines[]vertices", "23-0": "polylines[]stroke_color", "22-0": "polylines[]line_width", "21-0": "polylines[]label", "26-2": "number, min = -180, max = 180", "26-3": "Longitude.", "25-3": "Latitude.", "25-2": "number, min = -90, max = 90", "24-2": "array of objects, min items = 2, max items = 20", "24-3": "The coordinates of the vertices of the lines. It's in the form of [{\"lat\": <latitude 1>, \"lon\": <longitude 1>}, ...].", "23-3": "The color of the lines.", "23-2": "CSS color", "22-2": "number", "22-3": "The width of the lines.", "21-3": "The label of the polyline.", "21-2": "string", "20-2": "number, min = -180, max = 180", "20-3": "Longitude.", "19-3": "Latitude.", "19-2": "number, min = -90, max = 90", "18-3": "The coordinates of the vertices of the polygon. It's in the form of [{\"lat\": <latitude 1>, \"lon\": <longitude 1>}, ...].", "18-2": "array of objects, min items = 3, max items = 20", "17-3": "The color of the lines.", "17-2": "The color of the lines.", "16-3": "The width of the lines.", "16-2": "number", "15-2": "string", "15-3": "The label of the polygon.", "14-3": "The fill color.", "14-2": "CSS color" }, "cols": 4, "rows": 27 } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/vcaz7nAbSJysOaPvJq2a_map.png", "map.png", "800", "215", "#5c93ad", "" ] } ] } [/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 }}