Data Analytics Service API
Resource Group ¶
Analytics Events ¶
Create an Analytics EventPOST/api/v1/analytics_events
Example URI
POST /api/v1/analytics_events
Request
Headers
Content-Type: application/json
Accept: application/json
Body
{
"customer_id": "customer_id",
"entity_id": "ID",
"entity_type": "lead or contact",
"user_id": "current user ID",
"tool_signature": "tool signature",
"recording_id": "gpdb recording ID",
"event_type": "view",
"event_id": "event ID",
"message": "message",
"javascript_local_time": "local_time",
"apex_local_time": "local_time",
"event_environment_path": "path",
"name_parser_event_id": "event_id",
"recommendation_model_event_id": "event_id",
"version_info": {
"key": "value"
}
}
Response
201
Headers
Content-Type: application/json
Response
422
Headers
Content-Type: application/json
Lead Analytics ¶
Search a Lead Analytics EventGET/api/v1/lead_analytics/search
Example URI
GET /api/v1/lead_analytics/search
URI Parameters
- recording_id
array of string
(required)- customer_id
string
(required)- user_id
string
(required)- lead_id
string
(required)- latest
boolean
(optional)- page
string
(optional)Page number
- pageSize
string
(optional)Page size
Request
Headers
Content-Type: application/json
Accept: application/json
Response
200
Headers
Content-Type: application/json
Body
{
"recordings":
[
{
"customer_id": "customer#2",
"entity_type": "lead",
"entity_id": "contact#1",
"user_id": "user#2",
"tool_signature": "vfp",
"recording_id": "recording#2",
"event_type": "view",
"event_id": "view#1",
"message": "message",
"created_at": "2018-11-02T13:12:04.000Z",
"updated_at": "2018-11-02T13:12:04.000Z"
}
]
"meta":
{
"page": 1,
"pageSize": 10,
"rowCount": 2
}
}
Create a Lead Analytics EventPOST/api/v1/lead_analytics
Example URI
POST /api/v1/lead_analytics
Request
Headers
Content-Type: application/json
Accept: application/json
Body
{
"customer_id": "customer_id",
"lead_id": "ID",
"user_id": "current user ID",
"tool_signature": "tool signature",
"recording_id": "gpdb recording ID",
"event_type": "view",
"event_id": "event ID",
"message": "message",
"javascript_local_time": "local_time",
"apex_local_time": "local_time",
"event_environment_path": "path",
"name_parser_event_id": "event_id",
"recommendation_model_event_id": "event_id",
"version_info": {
"key": "value"
}
}
Response
201
Headers
Content-Type: application/json
Body
{
"customer_id": "customer_id",
"lead_id": "ID",
"user_id": "current user ID",
"tool_signature": "tool signature",
"recording_id": "gpdb recording ID",
"event_type": "view",
"event_id": "event ID",
"message": "message",
"entityType": "lead_analytics_event",
"partitionKey": "Lead analytics event|a4d45290-af9b-11e8-b20e-0d4f82fa24f6",
"sortKey": "customer_id",
"created_at": "2018-09-03T17:06:05.719Z",
"updated_at": "2018-09-03T17:06:05.719Z"
}
Response
422
Headers
Content-Type: application/json
Contact Analytics ¶
Search a Contact Analytics EventGET/api/v1/contact_analytics/search
Example URI
GET /api/v1/contact_analytics/search
URI Parameters
- recording_id
array of string
(required)- customer_id
string
(required)- user_id
string
(required)- contact_id
string
(required)- latest
boolean
(optional)- page
string
(optional)Page number
- pageSize
string
(optional)Page size
Request
Headers
Content-Type: application/json
Accept: application/json
Response
200
Headers
Content-Type: application/json
Body
{
"recordings":
[
{
"customer_id": "customer#2",
"entity_type": "lead",
"entity_id": "contact#1",
"user_id": "user#2",
"tool_signature": "vfp",
"recording_id": "recording#2",
"event_type": "view",
"event_id": "view#1",
"message": "message",
"created_at": "2018-11-02T13:12:04.000Z",
"updated_at": "2018-11-02T13:12:04.000Z"
}
]
"meta":
{
"page": 1,
"pageSize": 10,
"rowCount": 2
}
}
Create a Contact Analytics EventPOST/api/v1/contact_analytics
Example URI
POST /api/v1/contact_analytics
Request
Headers
Content-Type: application/json
Accept: application/json
Body
{
"customer_id": "customer_id",
"contact_id": "ID",
"user_id": "current user ID",
"tool_signature": "tool signature",
"recording_id": "gpdb recording ID",
"event_type": "view",
"event_id": "event ID",
"message": "message",
"javascript_local_time": "local_time",
"apex_local_time": "local_time",
"event_environment_path": "path",
"name_parser_event_id": "event_id",
"recommendation_model_event_id": "event_id",
"version_info": {
"key": "value"
}
}
Response
201
Headers
Content-Type: application/json
Body
{
"customer_id": "customer_id",
"contact_id": "ID",
"user_id": "current user ID",
"tool_signature": "tool signature",
"recording_id": "gpdb recording ID",
"event_type": "view",
"event_id": "event ID",
"entityType": "contact_analytics_event",
"partitionKey": "Contact analytics event|f52d2b90-af9b-11e8-b20e-0d4f82fa24f6",
"sortKey": "customer_id",
"message": "message",
"created_at": "2018-09-03T17:08:20.299Z",
"updated_at": "2018-09-03T17:08:20.299Z"
}
Response
422
Headers
Content-Type: application/json
Browser Extension Analytics ¶
Create a Browser Extension Analytics EventPOST/api/v1/lead_analytics
Example URI
POST /api/v1/lead_analytics
Request
Headers
Content-Type: application/json
Accept: application/json
Body
{
"customer_id": "ID",
"entity_id": "ID",
"user_id": "ID",
"tool_signature": "browser_extension",
"recording_id": "gpdb recording ID",
"event_type": "view",
"event_id": "event ID",
"message": "message",
"javascript_local_time": "local_time",
"apex_local_time": "local_time",
"event_environment_path": "path",
"name_parser_event_id": "event_id",
"recommendation_model_event_id": "event_id",
"version_info": {
"key": "value"
}
}
Response
201
Headers
Content-Type: application/json
Response
422
Headers
Content-Type: application/json