Analytics API

Retrieving audit information.

Endpoint to retrieve ids of audit events: /api/admin_audit/ids

Parameters:

• cat_exact:The name of the event category you want. Note: You can use multiple cat_exact parameters in one query.
• date_start: The start-date used for the query. Default: a week ago.
• date_end:The end-date used for the query. Default: now.
• page:If the query results in > 1000 ids, the result is split into separate pages. Increase this number to retrieve the next page. Default: 1

Possible categories:

• Authentication events: logon, logoff, logon_error
• Cobrowsing events: cobrowse_session_stopped
• Chat: conversation_activated, conversation_closed, conversation_missed, conversation_rated, conversation_categorized, conversation_deleted

Example:

$ curl --basic -u user1:****** https://channel.me/api/admin_audit/ids?cat_exact=logoff\&cat_exact=logon
[915,916,917,918,919]

Retrieve information on a single audit event: /api/admin_audit/get

    id: The id of the audit event you want to retrieve.

Returns technical information on the audit event.

Example:

$ curl --basic -u user1:****** https://channel.me/api/admin_audit/get?id=919
{"id":352,
 "category_id":518,
 "user_id":1,
 "content_group_id":491,
 "ua_id":null,
 "ip_address":"127.0.0.1",
 "created":"2017-10-10T10:04:04+00:00",
 "conversation_id":576,
 "duration":14,
 "group_id":352,
 "creator_id":328}

The id field is the id of this audit event,

The category_id contains the id of this event. More details about this category can be retrieved via the https://channel.me/api/base/export endpoint.

Example:

curl --basic -u user1:****** https://channel.me/api/base/export?id=518
{"id":518,
 "uri":"http://channel.it:8000/id/518",
 "rsc":{
   "category":"category",
   "content_group":"system_content_group",
   "content_group_id":453,
   "category_id":116,
   "created":"2017-06-19T09:22:58+00:00",
   "creator_id":1,
   "id":518,
   "is_authoritative":true,
   "is_dependent":false,
   "is_featured":false,
   "is_protected":true,
   "is_published":true,
   "modified":"2017-06-19T09:22:58+00:00",
   "name":"conversation_closed",
   "publication_start":"2017-06-19T09:22:58+00:00",
   "slug":"conversation-closed",
   "version":1,
   "visible_for":0,
   "installed_by":"mod_conversation_audit",
   "managed_props": {"title":"Conversation Closed"},
   "title":"Conversation Closed",
   "tz":"Europe/Berlin"
 }