{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:site_id/activities","auth":"required","examples":{"codes":[{"code":"{\n  \"activity\":{\n    \"subscriber\":{\n      \"uid\":\"frodo.baggins\"\n    },\n    \"event\":\"ring_destroyed\",\n    \"timestamp\":\"2015-07-15T19:30:00Z\",\n    \"properties\":{\n      \"location\":\"mount_doom\",\n      \"ring_owner\":\"sauron\"\n    }\n  }\n}","language":"json"}]},"method":"post","params":[{"name":"activity.subscriber.uid","type":"string","default":"","desc":"Unique ID of the user who performed the activity. This is the same UID that you use to identify your users and must have sent as part of the \"uid\" property while creating the user.","required":false,"in":"body","ref":"","_id":"56ec26de1b16a3290030cf5c"},{"name":"activity.event","type":"string","default":"","desc":"Name of the activity. You can refer to this name when searching for activities or in the message.","required":false,"in":"body","ref":"","_id":"56ec26de1b16a3290030cf5b"},{"name":"activity.timestamp","type":"datetime","default":"","desc":"Time of the activity. Should be sent in ISO8601 format. Defaults to current timestamp if not specified.","required":false,"in":"body","ref":"","_id":"56ec26de1b16a3290030cf5a"},{"name":"activity.properties","type":"object","default":"","desc":"Name-value pairs of additional attributes you'd like to associate with the activity. You can send a nested hash of basic name-value pairs. General convention is to send the keys in lower case separated with \"underscore\". If not sent, the system automatically converts them.","required":false,"in":"body","ref":"","_id":"56ec26de1b16a3290030cf59"},{"name":"site_id","type":"string","default":"","desc":"ZMP Site ID","required":false,"in":"path","ref":"","_id":"6059f0dd1956e600116f6557"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"event\":\"ring_destroyed\",\n  \"timestamp\":\"2015-07-15T19:30:00.000Z\",\n  \"properties\":{\n    \"location\":\"mount_doom\",\n    \"ring_owner\":\"sauron\"\n  },\n  \"account\":{\n    \"id\":5,\n    \"api_key\":\"00419cc2eabfbc719c62c64a041f76b6\"\n  },\n  \"subscriber\":{\n    \"id\":954,\n    \"uid\":\"frodo.baggins\"\n  }\n}","name":""}]},"settings":"56ea050204dc470e002870f1"},"next":{"description":"","pages":[]},"title":"Track an Event","type":"endpoint","slug":"track-an-event-rest","excerpt":"Track an event by a user","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Required Headers\",\n    \"h-1\": \"Value\",\n    \"0-0\": \"Content-Type\",\n    \"0-1\": \"application/json\",\n    \"1-0\": \"Accept\",\n    \"1-1\": \"application/json\",\n    \"2-0\": \"Authorization\",\n    \"2-1\": \"Basic <Auth Key>\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","updates":[],"order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56ec26de1b16a3290030cf58","editedParams":true,"project":"56aff08c3a5b810d00745d99","githubsync":"","parentDoc":null,"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56aff08d3a5b810d00745d9d","56aff24f3a5b810d00745da0","56aff25dbc304a0d00ace207","56aff287e0b1e40d00c53798","56aff2b260a37a0d00ed8883","56aff2b8e0b1e40d00c53799","56aff2bd5b1f01170014dc7b","56aff2c9d21e9c0d00b62993","56aff493aef9a21700da0e67","56aff4ce1486990d009c0f64","56aff4da5b1f01170014dc7d","56aff4dfe0b1e40d00c537a2","56aff4e59d32e30d0006d3e9","56aff4e91486990d009c0f65","56aff4f93a5b810d00745da2","56aff4fe9d32e30d0006d3ea","56b91c7ab1e03e0d001057c5","56c4f51aba4a540d0091b9a2","56cd09488c4a331d002c1e44","56d4ec4773dcd20b00fb8769","56e79bc515f96b2200878e54","56ec25c538ff1d2200d56cc2","56ec3a6f36bc8e0e00f190c8","56ec3e308ea7ce0e00a3d8b0","5724d8fe4255580e005938b2","5724dc842ad0bc1700122803","5776ef2a04f7500e0095dc37","57ab9f70b5e8742000e17eb9","57d7117646dcc30e007dd21f","58e6abd5b1eece19008b7d31","59288c65e2653627003e1221","5a8f4797a44f8600128e75ee","5bbf8833eb416300039a2c14","5ea811617bf4b5007328a0af"],"_id":"56aff08c3a5b810d00745d9c","project":"56aff08c3a5b810d00745d99","releaseDate":"2016-02-01T23:55:56.544Z","__v":34,"createdAt":"2016-02-01T23:55:56.544Z"},"__v":3,"category":{"sync":{"isSync":false,"url":""},"pages":["56ec26de1b16a3290030cf58"],"title":"Zeta REST API","slug":"bme-rest-api","order":2,"from_sync":false,"reference":true,"_id":"56ec25c538ff1d2200d56cc2","version":"56aff08c3a5b810d00745d9c","__v":1,"createdAt":"2016-03-18T15:59:01.460Z","project":"56aff08c3a5b810d00745d99"},"createdAt":"2016-03-18T16:03:42.680Z","editedParams2":true,"user":"565cab12d18ae50d0071839e"}

postTrack an Event

Track an event by a user

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

site_id:
string
ZMP Site ID

Body Params

activity.subscriber.uid:
string
Unique ID of the user who performed the activity. This is the same UID that you use to identify your users and must have sent as part of the "uid" property while creating the user.
activity.event:
string
Name of the activity. You can refer to this name when searching for activities or in the message.
activity.timestamp:
datetime
Time of the activity. Should be sent in ISO8601 format. Defaults to current timestamp if not specified.
activity.properties:
object
Name-value pairs of additional attributes you'd like to associate with the activity. You can send a nested hash of basic name-value pairs. General convention is to send the keys in lower case separated with "underscore". If not sent, the system automatically converts them.

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Required Headers", "h-1": "Value", "0-0": "Content-Type", "0-1": "application/json", "1-0": "Accept", "1-1": "application/json", "2-0": "Authorization", "2-1": "Basic <Auth Key>" }, "cols": 2, "rows": 3 } [/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 }}