{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/event/:site_id","auth":"required","params":[{"name":"site_id","type":"string","default":"","desc":"The unique identifier for your Boomtrain site.","required":true,"in":"path","ref":"","_id":"576d61ac4bcd290e004289b6"},{"name":"site_id","type":"string","default":"","desc":"The unique identifier for your Boomtrain site.","required":true,"in":"body","ref":"","_id":"593ee807b8bb9b002f176c25"},{"name":"bsin","type":"string","default":"","desc":"The Boomtrain identifier returned by a previous [identify](https://boomtrain.readme.io/docs/get-person) call for this person.","required":true,"in":"body","ref":"","_id":"56da2e667222d50b00701697"},{"name":"event_type","type":"string","default":"","desc":"The name of the event, e.g. \"viewed\", \"liked\", \"shared\"","required":true,"in":"body","ref":"","_id":"56da2e667222d50b00701696"},{"name":"resource_type","type":"string","default":"","desc":"The type of resource being acted upon.","required":false,"in":"body","ref":"","_id":"56da2e667222d50b00701695"},{"name":"resource_id","type":"string","default":"","desc":"The ID for the resource being acted upon.","required":false,"in":"body","ref":"","_id":"56da2e667222d50b00701694"},{"name":"timestamp","type":"string","default":"","desc":"ISO-8601 Timestamp OR Epoch time in milliseconds If unspecified, defaults to the current time. If it fails to parse, or if the timestamp represents a time before two years in the past or after the current time plus one day, the event will be rejected.","required":false,"in":"body","ref":"","_id":"56da2e667222d50b00701693"}],"results":{"codes":[{"status":200,"name":"","code":"OK","language":"text"}]},"settings":"57081bd855a4690e005de36f","examples":{"codes":[{"code":"curl -H 'Content-Type:application/json' -X POST  -d '{\"bsin\": \"bsin_returned_from_identify\", \"resource_type\":\"article\", \"resource_id\":\"12345\", \"site_id\": \"your-site\", \"event_type\":\"viewed\", \"timestamp\":\"2016-01-20T06:12:00-08:00\"}' 'https://events.api.boomtrain.com/event/your-site'","language":"curl"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Track an Event","type":"endpoint","slug":"track-an-event","excerpt":"Tracks a user behavior event.","body":"Events (also known as *activities*) are used to indicate that a user performed a particular action. These events will appear in your user's profile as recent history, and can be used to create behaviors for triggers and segmentation in the Zeta Marketing Platform. As well, these events act as signals for Zeta's personalization systems to generate insight and predictive recommendations for your campaigns.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Reserved Fields\"\n}\n[/block]\nNote that the request will be rejected if the event properties contain fields with the same name as any of the following reserved keywords:\n`enriched`, `event_id`, `geolocation`, `http_method`, `identified`, `identity`, `is_bot`, `is_test`, `properties`, `referer`, `status`, `url`, `user_agent`","updates":[],"order":14,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56da2e667222d50b00701692","__v":6,"editedParams":true,"user":"566887ff8639090d00759415","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"},"githubsync":"","parentDoc":null,"createdAt":"2016-03-05T00:55:02.781Z","editedParams2":true,"project":"56aff08c3a5b810d00745d99","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"}}

postTrack an Event

Tracks a user behavior event.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Body Params

site_id:
required
string
The unique identifier for your Boomtrain site.
bsin:
required
string
The Boomtrain identifier returned by a previous [identify](https://boomtrain.readme.io/docs/get-person) call for this person.
event_type:
required
string
The name of the event, e.g. "viewed", "liked", "shared"
resource_type:
string
The type of resource being acted upon.
resource_id:
string
The ID for the resource being acted upon.
timestamp:
string
ISO-8601 Timestamp OR Epoch time in milliseconds If unspecified, defaults to the current time. If it fails to parse, or if the timestamp represents a time before two years in the past or after the current time plus one day, the event will be rejected.

Examples


Result Format


Documentation

Events (also known as *activities*) are used to indicate that a user performed a particular action. These events will appear in your user's profile as recent history, and can be used to create behaviors for triggers and segmentation in the Zeta Marketing Platform. As well, these events act as signals for Zeta's personalization systems to generate insight and predictive recommendations for your campaigns. [block:api-header] { "type": "basic", "title": "Reserved Fields" } [/block] Note that the request will be rejected if the event properties contain fields with the same name as any of the following reserved keywords: `enriched`, `event_id`, `geolocation`, `http_method`, `identified`, `identity`, `is_bot`, `is_test`, `properties`, `referer`, `status`, `url`, `user_agent`

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 }}