Activities Endpoint

The activities endpoint returns UBA (User Behavioral Analysis) activities.

Field Name
Type
Description
Possible Values

event_id

string

This is the Cloudlock Internal Identifier for an activity

client_ip

string

The client's IP address

event_type

string

The type of the event

created_at

timestamp

When the activity took place, in UTC

operation_successful

Boolean

Did the activity succeed

client_location

resource

Client location information

event_category

string

The event category type

origin_id

string

The origin id

user

resource

User information

user_agent

string

vendor

resource

Platform information. See the vendor resource

extra

resource

Additional information related to the activity

extra.auth

resource

Authentication information related to the activity

extra.auth.auth_type

string

Type of authentication

extra.auth.is_suspicious

Boolean

Indication regarding whether the activity is flagged as being suspicious

raw

resource

Raw information for the activity

Activities Filters

Filter
Usage
Example

event_type

Filter based on the event type i.e. login, user_settings, other

created_after

Filter based on the creation date

Activities

[/activities]
List activities [GET]

  • Response 200 (application/json)
{
 "limit": 3,
 "offset": 0,
 "total": 686,
 "results": 3,
 "items": [
  {
   "event_id": "-6285966971996490902#0",
   "client_ip": "86.176.87.160",
   "event_type": "login",
   "created_at": "2018-06-23T15:18:09.000Z",
   "operation_successful": true,
   "client_location": {
    "lat": 51.8,
    "lng": -0.35,
    "country": {
     "code": "GB",
     "name": "United Kingdom"
    },
    "region": {
     "code": "F8",
     "name": "Hertford"
    },
    "city": "Harpenden"
   },
   "event_category": "auth",
   "origin_id": "-6285966971996490902",
   "user": {
    "vendor_id": "108287862377325873441",
    "user_email": "[email protected]"
   },
   "user_agent": "",
   "vendor": {
    "name": "google",
    "service": "auth"
   },
   "extra": {
    "auth": {
     "auth_type": "",
     "is_suspicious": null
    }
   },
   "raw": {
    "kind": "admin#reports#activity",
    "actor": {
     "profileId": "108287862377325873441",
     "email": "[email protected]"
    },
    "id": {
     "uniqueQualifier": "-6285966971996490902",
     "applicationName": "login",
     "customerId": "C015wxbys",
     "time": "2018-06-23T15:18:09.000Z"
    },
    "etag": "\"RU_ANZvud_qrxRGJHqK2w1PCmE4/mLe1pMbCGKexbLn4QBfOSNhifXY\"",
    "ipAddress": "86.176.87.160",
    "events": [
     {
      "type": "login",
      "name": "login_success",
      "parameters": [
       {
        "name": "login_type",
        "value": "google_password"
       }
      ]
     }
    ]
   }
  },
  {
   "event_id": "-4132259428371024344#0",
   "client_ip": "73.182.132.44",
   "event_type": "login",
   "created_at": "2018-06-23T15:16:24.000Z",
   "operation_successful": true,
   "client_location": {
    "lat": 38,
    "lng": -97,
    "country": {
     "code": "US",
     "name": "United States"
    },
    "region": {
     "code": "",
     "name": ""
    },
    "city": ""
   },
   "event_category": "auth",
   "origin_id": "-4132259428371024344",
   "user": {
    "vendor_id": "113792970216799399389",
    "user_email": "[email protected]"
   },
   "user_agent": "",
   "vendor": {
    "name": "google",
    "service": "auth"
   },
   "extra": {
    "auth": {
     "auth_type": "",
     "is_suspicious": null
    }
   },
   "raw": {
    "kind": "admin#reports#activity",
    "actor": {
     "profileId": "113792970216799399389",
     "email": "[email protected]"
    },
    "id": {
     "uniqueQualifier": "-4132259428371024344",
     "applicationName": "login",
     "customerId": "C015wxbys",
     "time": "2018-06-23T15:16:24.000Z"
    },
    "etag": "\"RU_ANZvud_qrxRGJHqK2w1PCmE4/euy8WO2wN-_3p2HpvxzOx47mxd4\"",
    "ipAddress": "73.182.132.44",
    "events": [
     {
      "type": "login",
      "name": "login_success",
      "parameters": [
       {
        "name": "login_type",
        "value": "google_password"
       }
      ]
     }
    ]
   }
  },
  {
   "event_id": "-6584956397417228660#0",
   "client_ip": "71.184.65.70",
   "event_type": "login",
   "created_at": "2018-06-23T14:37:02.000Z",
   "operation_successful": true,
   "client_location": {
    "lat": 42.3699,
    "lng": -71.2353,
    "country": {
     "code": "US",
     "name": "United States"
    },
    "region": {
     "code": "MA",
     "name": "Massachusetts"
    },
    "city": "Waltham"
   },
   "event_category": "auth",
   "origin_id": "-6584956397417228660",
   "user": {
    "vendor_id": "110344796083626325790",
    "user_email": "[email protected]"
   },
   "user_agent": "",
   "vendor": {
    "name": "google",
    "service": "auth"
   },
   "extra": {
    "auth": {
     "auth_type": "",
     "is_suspicious": null
    }
   },
   "raw": {
    "kind": "admin#reports#activity",
    "actor": {
     "profileId": "110344796083626325790",
     "email": "[email protected]"
    },
    "id": {
     "uniqueQualifier": "-6584956397417228660",
     "applicationName": "login",
     "customerId": "C015wxbys",
     "time": "2018-06-23T14:37:02.000Z"
    },
    "etag": "\"RU_ANZvud_qrxRGJHqK2w1PCmE4/lljsRbbC-u0pGaQed0g6TriZinU\"",
    "ipAddress": "71.184.65.70",
    "events": [
     {
      "type": "login",
      "name": "login_success",
      "parameters": [
       {
        "name": "login_type",
        "value": "google_password"
       }
      ]
     }
    ]
   }
  }
 ]
}

Updated 2 years ago

Activities Endpoint


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.