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

400

A query parameter is invalid: filters is not a JSON array, a filter is missing property_name or operator, a filter uses an unsupported operator or has no property_value, or timezone, interval, group_by or timeframe is invalid. errors maps each failing parameter to its messages.

401

Authorization information is missing or invalid.

429

Reports are temporarily unavailable: the analytics provider is throttling queries, a query did not finish in 300 seconds, or the provider returned an invalid response. When throttled, wait for Retry-After before retrying.

503

Reports service is temporarily unavailable: the analytics provider cannot be reached or reports it is unavailable.

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


400
A query parameter is invalid: filters is not a JSON array, a filter is missing property_name or operator, a filter uses an unsupported operator or has no property_value, or timezone, interval, group_by or timeframe is invalid. errors maps each failing parameter to its messages.


401
Authorization information is missing or invalid.


429
Reports are temporarily unavailable: the analytics provider is throttling queries, a query did not finish in 300 seconds, or the provider returned an invalid response. When throttled, wait for Retry-After before retrying.


503
Reports service is temporarily unavailable: the analytics provider cannot be reached or reports it is unavailable.


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
Returns event count for the given timeframe and filters (Keen leadconduit.events).


Total Events (single scalar): Use the same timeframe and filters as the Events list/charts, and omit group_by and interval. The response is a scalar: result is the total event count. With group_by and/or interval, the response is time-series; sum result[].value[].result (and across timeframe buckets) to derive a total.


Unclaimed Certificates count: To get the count that matches "Unclaimed" rows in the Events table (events with no TrustedForm cert URL and no vars.trustedform), use the same timeframe and filters as the list plus these two filters:


    

  • property_name vars.lead.trustedform_cert_url, operator is blank
    • 

  • property_name vars.trustedform, operator is blank
The backend maps "is blank" to Keen operator "exists" with property_value false (property does not exist). The metric card count must match the number of "Unclaimed" rows 1:1.
    • 



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
Keen-style filters (property_name, operator, property_value). For Unclaimed Certificates count, include property_name vars.lead.trustedform_cert_url operator is blank and property_name vars.trustedform operator is blank in addition to the same filters used for the Events list.


 
Responses 
200
OK. When group_by and interval are omitted, result is a scalar number (total count). With group_by/interval, result is an array of value/timeframe objects.


400
A query parameter is invalid: filters is not a JSON array, a filter is missing property_name or operator, a filter uses an unsupported operator or has no property_value, or timezone, interval, group_by or timeframe is invalid. errors maps each failing parameter to its messages.


401
Authorization information is missing or invalid.


429
Reports are temporarily unavailable: the analytics provider is throttling queries, a query did not finish in 300 seconds, or the provider returned an invalid response. When throttled, wait for Retry-After before retrying.


503
Reports service is temporarily unavailable: the analytics provider cannot be reached or reports it is unavailable.


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


400
A query parameter is invalid: filters is not a JSON array, a filter is missing property_name or operator, a filter uses an unsupported operator or has no property_value, or timezone, interval, group_by or timeframe is invalid. errors maps each failing parameter to its messages.


401
Authorization information is missing or invalid.


429
Reports are temporarily unavailable: the analytics provider is throttling queries, a query did not finish in 300 seconds, or the provider returned an invalid response. When throttled, wait for Retry-After before retrying.


503
Reports service is temporarily unavailable: the analytics provider cannot be reached or reports it is unavailable.


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


400
A query parameter is invalid: filters is not a JSON array, a filter is missing property_name or operator, a filter uses an unsupported operator or has no property_value, or timezone, interval, group_by or timeframe is invalid. errors maps each failing parameter to its messages.


401
Authorization information is missing or invalid.


429
Reports are temporarily unavailable: the analytics provider is throttling queries, a query did not finish in 300 seconds, or the provider returned an invalid response. When throttled, wait for Retry-After before retrying.


503
Reports service is temporarily unavailable: the analytics provider cannot be reached or reports it is unavailable.


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