Retrieve statistics on events
The /events/stats resource is used to count events. The event count can be grouped by any field collected
with the lead or appended to the lead during flow processing. The API also supports returning results in JSON
or CSV using the appropriate MIME type in the Accept header.
Authorizations
LeadConduit uses HTTP Basic Authentication
with the username API and your API key as the password.
For example: API:1f1b96c9150d8050e858c043d543bb4eadae0e6f'
Query Parameters
Convenience option that specifies a filter on event type (source, recipient, filter, feedback-received, or feedback-sent). Can be used multiple times to specify multiple types. (default: source)
Limit counted events using this rule. Can be used multiple times to specify multiple rules. Each rule must be sent as URL encoded JSON.
- Binary Rule
- Unary Rule
Group event counts by unique values of this property. Can be used multiple times to specify multiple properties. (default: none)
Groups event counts into sub-timeframes spanning a specified length of time: minutely, hourly, daily, weekly, monthly, yearly (default: none)
When an interval is specified, this time zone will be used to set the start and end of each interval. Any tz database time zone name (i.e. America/Chicago) or the number of seconds to offset time from UTC (i.e. -18000)
Count events that were created at or after this time (default: beginning of the day today)
Count events that were created at or before this time (default: end of the day today)
DEPRECATED: use column instead. The outcome to count (default: success, failure, error). Can be used multiple times to specify multiple types.
A column to aggregate. Can be used multiple times to specify multiple columns. source-success, source-failure, source-error
Boolean indicating whether to count unique leads or unique events - false counts individual events (default: true)
Response
OK
Total number of leads submitted to LeadConduit by a source
Total number of leads submitted to LeadConduit by a source resulting in success (lead was purchased)
Total number of leads submitted to LeadConduit by a source resulting in failure (lead was not purchased)
Total number of leads submitted to LeadConduit by a source resulting in error
Total number of leads submitted by LeadConduit to a recipient
Total number of leads submitted by LeadConduit to a recipient resulting in success (lead was purchased)
Total number of leads submitted by LeadConduit to a recipient resulting in failure (lead was not purchased)
Total number of leads submitted by LeadConduit to a recipient resulting in error
Total number of returns to LeadConduit by a recipient
Total number of returns to LeadConduit by a recipient resulting in success (lead was returned)
Total number of returns to LeadConduit by a recipient resulting in failure (return was denied)
Total number of returns to LeadConduit by a recipient resulting in error
Total number of returns sent by LeadConduit to a source
Total number of returns sent by LeadConduit to a source resulting in success (lead was returned to the source)
Total number of returns sent by LeadConduit to a source resulting in failure (return was denied by the source)
Total number of returns sent by LeadConduit to a source resulting in error
Total number of conversions to LeadConduit by a recipient
Total number of conversions to LeadConduit by a recipient resulting in success (lead was marked converted)
Total number of conversions to LeadConduit by a recipient resulting in failure (conversion was denied)
Total number of conversions to LeadConduit by a recipient resulting in error
Total number of conversions sent by LeadConduit to a source
Total number of conversions sent by LeadConduit to a source resulting in success (lead was reported converted to the source)
Total number of conversions sent by LeadConduit to a source resulting in failure (conversion was denied by the source)
Total number of conversions sent by LeadConduit to a source resulting in error
Total count of pings submitted to LeadConduit by a source
Total number of pings submitted to LeadConduit by a source that result in success
The percentage of submitted pings that resulted in success
The percentage of pings submitted by a source that resulted in a source submission
The total cost in USD for the leads purchased as determined by the source pricing configuration
The total revenue in USD for leads sold as determined by recipient pricing configuration
The difference between revenue and cost
The cost in USD for each successful conversion that occurred for the leads submitted during the specified timeframe.
The average cost in USD paid per lead calculated by dividing cost by the number of good leads (source-submitted-success minus return-sent-success)
The average revenue in USD received per lead calculated by dividing revenue by the number of good leads (recipient-submitted-success minus return-received-success)