{"_id":"57fcc4870312b20e00ac6523","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","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"},"__v":0,"project":"5435687035740020002a1c04","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-31T23:13:11.967Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"lua","name":"Agent Lua","code":"output.messages = array({\n\t{from = \"Telemetry\", text = \"First Message\", timestamp = 1431102409},\n\t{from = \"Telemetry\", text = \"Second Message\", timestamp = 1431102500},\n\t{from = \"Telemetry\", text = \"Third Message\", timestamp = 1431102800}\n})"}]},"method":"post","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":"","auth":"required","params":[{"_id":"5682d7d670331a0d00484a20","ref":"","in":"path","required":true,"desc":"The flow tag","default":"","type":"string","name":"timeline_flow_tag"},{"_id":"5682d7d670331a0d00484a1f","ref":"","in":"body","required":true,"desc":"See below for the message object","default":"","type":"array_object","name":"messages"}],"url":"/flows/:timeline_flow_tag/metrics"},"isReference":false,"order":20,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Message Object Parameter\",\n    \"h-1\": \"Required\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"The name of who posted the timeline event.\",\n    \"1-3\": \"The URL to the timeline event icon.\",\n    \"2-3\": \"The text body of the message.\",\n    \"3-3\": \"Time of the timeline message represented as seconds since the UNIX epoch.\",\n    \"3-2\": \"number, min = 0\",\n    \"2-2\": \"string\",\n    \"1-2\": \"URI\",\n    \"0-2\": \"string\",\n    \"0-0\": \"from\",\n    \"1-0\": \"icon_url\",\n    \"2-0\": \"text\",\n    \"3-0\": \"timestamp\",\n    \"3-1\": \"required\",\n    \"2-1\": \"required\",\n    \"0-1\": \"required\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9eLLlVf7QjmkiOCD6XV2_timeline.png\",\n        \"timeline.png\",\n        \"800\",\n        \"215\",\n        \"#8d6953\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"Timeline flows show a series of messages such as a Twitter series of tweets. For displaying a list of timeline events (like Twitter Tweets) you should send a messages array with multiple messages, each with a from, icon_url, timestamp and text.","slug":"timeline","type":"endpoint","title":"Timeline"}

postTimeline

Timeline flows show a series of messages such as a Twitter series of tweets. For displaying a list of timeline events (like Twitter Tweets) you should send a messages array with multiple messages, each with a from, icon_url, timestamp and text.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

timeline_flow_tag:
required
string
The flow tag

Body Params

messages:
required
array of objects
See below for the message object

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Message Object Parameter", "h-1": "Required", "h-2": "Type", "h-3": "Description", "0-3": "The name of who posted the timeline event.", "1-3": "The URL to the timeline event icon.", "2-3": "The text body of the message.", "3-3": "Time of the timeline message represented as seconds since the UNIX epoch.", "3-2": "number, min = 0", "2-2": "string", "1-2": "URI", "0-2": "string", "0-0": "from", "1-0": "icon_url", "2-0": "text", "3-0": "timestamp", "3-1": "required", "2-1": "required", "0-1": "required" }, "cols": 4, "rows": 4 } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/9eLLlVf7QjmkiOCD6XV2_timeline.png", "timeline.png", "800", "215", "#8d6953", "" ] } ] } [/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 }}