{"_id":"57fcc4870312b20e00ac6518","project":"5435687035740020002a1c04","__v":0,"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"},"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,"user":"5435682035740020002a1c01","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-03T19:15:58.809Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"output.leaders = array({\n\t{name = \"Leader 1\", description = \"Description 1\", points = 50},\n  {name = \"Leader 2\", description = \"Description 2\", points = 75}  \n})","language":"lua","name":"Agent.Lua"}]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"errors\": [\n    ],\n    \"skipped\": [\n    ],\n    \"updated\": [\n    \t\"your_flow_tag\"\n    ]\n}","name":""},{"status":400,"language":"json","code":"{\n    \"errors\": [\n        \"error description\"\n    ],\n    \"skipped\": [\n    \t\"your_flow_tag\"\n    ],\n    \"updated\": [\n    ]\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"57a45c7426785a0e00b69a48","ref":"","in":"path","required":true,"desc":"The flow tag","default":"","type":"string","name":"leaderboard_flow_tag"},{"_id":"57a45c7426785a0e00b69a47","ref":"","in":"body","required":false,"desc":"CSS color for the highlight","default":"","type":"string","name":"highlight_color"},{"_id":"57a45c7426785a0e00b69a46","ref":"","in":"body","required":false,"desc":"CSS color for the stripe","default":"","type":"string","name":"stripe_color"},{"_id":"57a45c7426785a0e00b69a45","ref":"","in":"body","required":false,"desc":"Whether to paginate or not. Possible values are \"none\" or \"auto\"","default":"auto","type":"string","name":"paginate"},{"_id":"57a45c7426785a0e00b69a44","ref":"","in":"body","required":true,"desc":"See the Leaders object below","default":"","type":"array_object","name":"leaders"}],"url":"/flows/:leaderboard_flow_tag/metrics"},"isReference":false,"order":9,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Leaders Object Parameter\",\n    \"h-1\": \"Required\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"required\",\n    \"0-2\": \"string\",\n    \"0-3\": \"The name of the team\",\n    \"1-0\": \"description\",\n    \"1-2\": \"string\",\n    \"2-0\": \"points\",\n    \"2-1\": \"required\",\n    \"2-2\": \"number\",\n    \"1-3\": \"The team description\",\n    \"2-3\": \"The score / points of the team\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b6c3f7b-leaderboard.png\",\n        \"leaderboard.png\",\n        441,\n        260,\n        \"#050504\"\n      ],\n      \"sizing\": \"smart\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"leaderboard","type":"endpoint","title":"Leaderboard"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

leaderboard_flow_tag:
required
string
The flow tag

Body Params

highlight_color:
string
CSS color for the highlight
stripe_color:
string
CSS color for the stripe
paginate:
stringauto
Whether to paginate or not. Possible values are "none" or "auto"
leaders:
required
array of objects
See the Leaders object below

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Leaders Object Parameter", "h-1": "Required", "h-2": "Type", "h-3": "Description", "0-0": "name", "0-1": "required", "0-2": "string", "0-3": "The name of the team", "1-0": "description", "1-2": "string", "2-0": "points", "2-1": "required", "2-2": "number", "1-3": "The team description", "2-3": "The score / points of the team" }, "cols": 4, "rows": 3 } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/b6c3f7b-leaderboard.png", "leaderboard.png", 441, 260, "#050504" ], "sizing": "smart" } ] } [/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 }}