Events

Get median event metrics

SecurityAPIKey
Request
query Parameters
max_age
number
Example: max_age=86400
target_property
string
group_by
Array of strings
timezone
number
Example: timezone=-18000
Responses
200

OK

401

Authorization information is missing or invalid.

get/events/event-metrics/median
Request samples 
Response samples 
application/json
{
  • "result": [
    • {
      • "type": "string",
      • "module_id": "string",
      • "median": 0
      }
    ]
}
Get funnel event metrics
SecurityAPIKey 
Request 
query Parameters
Event Metrics Timeframe Bounded (object) or Event Metrics Timeframe (string) (Event Metrics Timeframe) 
 
 Example:  timeframe=today
Event Metrics Interval (string) or Event Metrics Interval (object) (Event Metrics Interval) 
 
 Example:  interval=daily
timezone
number
 
 Example:  timezone=-18000
steps
Array of objects
 
Responses 
200
OK


401
Authorization information is missing or invalid.


get/events/event-metrics/funnel
Request samples 
Response samples 
application/json
{
  • "steps": [
    • {
      • "with_actors": true,
      • "actor_property": "string",
      • "event_collection": "string",
      • "filters": [
        • {
          • "operator": "string",
          • "property_name": "string",
          • "property_value": "string"
          }
        ]
      }
    ],
  • "result": [
    • 0
    ]
}
Get event metrics counts
SecurityAPIKey 
Request 
query Parameters
group_by
Array of strings
 
Event Metrics Timeframe Bounded (object) or Event Metrics Timeframe (string) (Event Metrics Timeframe) 
 
 Example:  timeframe=this_14_days
Event Metrics Interval (string) or Event Metrics Interval (object) (Event Metrics Interval) 
 
 Example:  interval=daily
timezone
number
 
 Example:  timezone=-18000
filters
Array of objects
 
Responses 
200
OK


401
Authorization information is missing or invalid.


get/events/event-metrics/count
Request samples 
Response samples 
application/json
{
  • "result": [
    • {
      • "value": [
        • {
          • "outcome": "string",
          • "result": 0
          }
        ],
      • "timeframe": {
        • "start": "2019-08-24T14:15:22Z",
        • "end": "2019-08-24T14:15:22Z"
        }
      }
    ]
}
Get unique event metrics counts
SecurityAPIKey 
Request 
query Parameters
group_by
Array of strings
 
Event Metrics Timeframe Bounded (object) or Event Metrics Timeframe (string) (Event Metrics Timeframe) 
 
 Example:  timeframe=this_14_days
Event Metrics Interval (string) or Event Metrics Interval (object) (Event Metrics Interval) 
 
 Example:  interval=daily
timezone
number
 
 Example:  timezone=-18000
filters
Array of objects
 
target_property
string
 
Responses 
200
OK


401
Authorization information is missing or invalid.


get/events/event-metrics/count_unique
Request samples 
Response samples 
application/json
{
  • "result": [
    • {
      • "value": [
        • {
          • "outcome": "string",
          • "result": 0
          }
        ],
      • "timeframe": {
        • "start": "2019-08-24T14:15:22Z",
        • "end": "2019-08-24T14:15:22Z"
        }
      }
    ]
}
Select unique event metrics
SecurityAPIKey 
Request 
query Parameters
group_by
Array of strings
 
Event Metrics Timeframe Bounded (object) or Event Metrics Timeframe (string) (Event Metrics Timeframe) 
 
 Example:  timeframe=this_14_days
Event Metrics Interval (string) or Event Metrics Interval (object) (Event Metrics Interval) 
 
 Example:  interval=daily
timezone
number
 
 Example:  timezone=-18000
filters
Array of objects
 
target_property
string
 
Responses 
200
OK


401
Authorization information is missing or invalid.


get/events/event-metrics/select_unique
Request samples 
Response samples 
application/json
{
  • "result": [
    • {
      • "vars.source.id": "string",
      • "vars.recipient.id": "string",
      • "result": [
        • "string"
        ]
      }
    ]
}