{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/events/recent/:site_id","auth":"required","settings":"57081bd855a4690e005de36f","examples":{"codes":[]},"method":"get","params":[{"name":"site_id","type":"string","default":"","desc":"The unique identifier for your Boomtrain site.","required":true,"in":"path","ref":"","_id":"57081bad1750330e00184c1d"},{"name":"count","type":"int","default":"100","desc":"Integer from 1-100 representing the number of recent events to return.","required":false,"in":"query","ref":"","_id":"57081bad1750330e00184c1c"},{"name":"event_type","type":"string","default":"","desc":"String representing the type of event to filter to. If unspecified, all events across all types may be returned.","required":false,"in":"query","ref":"","_id":"57081bad1750330e00184c1b"}],"results":{"codes":[{"name":"","code":"{\n  \"data\":\n\t[\n    {\n            \"bsin\": \"cu+8AJaa0z+UGi3jWFQS2wBTEkDpIpUDN50ju5gWfO7OYm0erTkV83Iw5q5qIiEXeEMCMlYz+T15/ajCqaLD8g==\",\n            \"event_type\": \"viewed\",\n            \"resource_id\": \"WpPost-54392\",\n            \"resource_type\": \"wp_post\",\n            \"site_id\": \"682\",\n            \"timestamp\": \"2016-04-12T21:15:54+00:00\"\n        },\n\t\t{\t\"bsin\":\"Y/NFaLKMPLWzgTmvx2KS6tNpPZDh/pOZAwn6jRufn8ydwR5YinYL0DWLwUey4CngRUHH28yOg9EhSZ+G2WvRVA==\", // Encrypted BSIN of the user\n\t\t\t\"event_type\": \"viewed\", // Type of event\n\t\t\t\"resource_type\": \"article\", // Resource Type for the resource(if present)\n\t\t\t\"resource_id\": \"12345\", // ResourceID for the resource (if present)\n     \t\"site_id\": \"your-site\", // Your site's unique Boomtrain identifier\n\t\t\t\"timestamp\": \"2016-04-12T21:15:54+00:00\" // ISO-8601 timestamp for the event in UTC\n\t\t},\n\t\t// ...\n\t]\n}","language":"json","status":200}]}},"next":{"description":"","pages":[]},"title":"Get Recent Events for a Site","type":"endpoint","slug":"get-recent-events-for-a-site","excerpt":"Returns a list of recent activity for the specified user. Optionally, you may filter the events to a particular event type.","body":"","updates":[],"order":15,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"57081bad1750330e00184c1a","user":"566887ff8639090d00759415","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"},"createdAt":"2016-04-08T20:59:25.446Z","project":"56aff08c3a5b810d00745d99","editedParams":true,"githubsync":"","parentDoc":null,"__v":0,"editedParams2":true,"category":{"sync":{"isSync":false,"url":""},"pages":["56d4ec8573dcd20b00fb876a"],"title":"Server-Side Integration REST API","slug":"authorization","order":3,"from_sync":false,"reference":true,"_id":"56d4ec4773dcd20b00fb8769","__v":1,"version":"56aff08c3a5b810d00745d9c","createdAt":"2016-03-01T01:11:35.547Z","project":"56aff08c3a5b810d00745d99"}}

getGet Recent Events for a Site

Returns a list of recent activity for the specified user. Optionally, you may filter the events to a particular event type.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

site_id:
required
string
The unique identifier for your Boomtrain site.

Query Params

count:
integer100
Integer from 1-100 representing the number of recent events to return.
event_type:
string
String representing the type of event to filter to. If unspecified, all events across all types may be returned.

Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}