View User events

GET /users/{id}/events
Copied
Arrow
                https://api.ocamba.com/v1/hood/users/{id}/events

Retrieves the details of a User for his events if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.


Example: fields=field1,field2,field3
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/hood/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/hood/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/hood/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,field2

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ user-event ]
An array of all created items.
User event
Name
Description
client_idstring
The ID of the client, generated by the Ocamba.


Example: 1642145067288515000
company_idstring
The ID of the Company, generated by the Ocamba.


Example: 1200000
eventstring
The event that has happened.


Example: impression

Possible values: block | impression | repeated_impression | dialog_accepted | push_enabled | push_disabled | update_userdata | error
event_datestring
Timezone: GMT.


Example: 2021-10-30
event_per_session_serialstring
The counter for every event per session.


Example: 1
event_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
new_sessionstring
It represents is new session created or not. Values could be 0 (false) or 1 (true).


Example: 1
page_ref_urlstring
The page referer where event has happened.


Example: https://dev.delsystems.net/solutions/business-intelligence.htm?2
page_urlstring
The url of the page where event has happened.


Example: https://dev.delsystems.net/
traffic_source_typestring
Traffic sources that are driving visitors to your website.


Example: link

Possible values: direct | internal | link | social network | search engine | paid | unknown | none
totalinteger
A total number of items.


Example: 17
tip
1 Sortable field is event_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 17,
  "items": [
      {
          "session_id": "0",
          "event_time": "2023-09-29 11:26:20",
          "new_session": "0",
          "event_per_session_serial": "0",
          "event": "userdata",
          "traffic_source_type": "Unknown"
      }]
}

{
  "total": 17,
  "items": [
    {
      "client_id": "1642145067288515000",
      "company_id": "1200000",
      "event_time": "2021-10-30 14:27:26",
      "event_date": "2021-10-30",
      "page_url": "https://dev.delsystems.net/",
      "page_ref_url": "https://dev.delsystems.net/solutions/business-intelligence.htm?2",
      "new_session": "1",
      "event_per_session_serial": "1",
      "event": "impression",
      "traffic_source_type": "link"
    }
  ]
}