Method | Description | |
---|---|---|
AddEvent ( string collection, object eventInfo, IEnumerable |
Add a single event to the specified collection.
|
|
AddEventAsync ( string collection, object eventInfo, IEnumerable |
Add a single event to the specified collection.
|
|
AddEvents ( string collection, IEnumerable |
Insert multiple events in a single request.
|
|
AddEventsAsync ( string collection, IEnumerable |
Add a collection of events to the specified collection
|
|
AddGlobalProperty ( string property, object value ) : void |
Add a static global property. This property will be added to every event.
|
|
DeleteCollection ( string collection ) : void |
Delete the specified collection. Deletion may be denied for collections with many events. Master API key is required.
|
|
DeleteCollectionAsync ( string collection ) : System.Threading.Tasks.Task |
Delete the specified collection. Deletion may be denied for collections with many events. Master API key is required.
|
|
GetQueries ( ) : string>>>.Task |
Retrieve a list of all the queries supported by the API.
|
|
GetSchema ( string collection ) : dynamic |
Retrieve the schema for the specified collection. This requires a value for the project settings Master API key.
|
|
GetSchemaAsync ( string collection ) : Task |
Retrieve the schema for the specified collection. This requires a value for the project settings Master API key.
|
|
GetSchemas ( ) : Newtonsoft.Json.Linq.JArray |
Return schema information for all the event collections in this project.
|
|
GetSchemasAsync ( ) : Task |
Return schema information for all the event collections in this project.
|
|
KeenClient ( IProjectSettings prjSettings ) : Keen.Core.DataEnrichment |
|
|
KeenClient ( IProjectSettings prjSettings, IEventCache eventCache ) : Keen.Core.DataEnrichment |
|
|
Query ( string queryName, string>.Dictionary |
Call any Keen.IO API function with the specified parameters. Refer to Keen API documentation for details of request parameters and return type. Return type may be cast as dynamic.
|
|
Query ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, QueryTimeframe timeframe = null, IEnumerable |
Return a single value.
|
|
QueryAsync ( string queryName, string>.Dictionary |
Call any Keen.IO API function with the specified parameters.
|
|
QueryAsync ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, QueryTimeframe timeframe = null, IEnumerable |
Run a query returning a single value.
|
|
QueryExtractResource ( string collection, QueryTimeframe timeframe = null, IEnumerable |
Extract full-form event data with all property values.
|
|
QueryExtractResourceAsync ( string collection, QueryTimeframe timeframe = null, IEnumerable |
Extract full-form event data with all property values.
|
|
QueryFunnel ( IEnumerable |
Funnels count relevant events in succession. See API documentation for details.
|
|
QueryFunnelAsync ( IEnumerable |
Funnels count relevant events in succession. See API documentation for details.
|
|
QueryGroup ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, string groupBy, QueryTimeframe timeframe = null, IEnumerable |
Returns values collected by group.
|
|
QueryGroupAsync ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, string groupBy, QueryTimeframe timeframe = null, IEnumerable |
Returns values collected by group.
|
|
QueryInterval ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, QueryTimeframe timeframe, Keen.Core.Query.QueryInterval interval = null, IEnumerable |
Returns values collected by time interval.
|
|
QueryIntervalAsync ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, QueryTimeframe timeframe, Keen.Core.Query.QueryInterval interval = null, IEnumerable |
Return values collected by time interval.
|
|
QueryIntervalGroup ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, string groupBy, QueryTimeframe timeframe, Keen.Core.Query.QueryInterval interval, IEnumerable |
Returns items collected by time interval and group.
|
|
QueryIntervalGroupAsync ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, string groupBy, QueryTimeframe timeframe, Keen.Core.Query.QueryInterval interval, IEnumerable |
Returns items collected by time interval and group.
|
|
QueryMultiAnalysis ( string collection, IEnumerable |
Run multiple types of analysis over the same data.
|
|
QueryMultiAnalysisAsync ( string collection, IEnumerable |
Run multiple types of analysis over the same data.
|
|
QueryMultiAnalysisGroup ( string collection, IEnumerable |
Run multiple types of analysis over the same data, grouped by the specified field.
|
|
QueryMultiAnalysisGroupAsync ( string collection, IEnumerable |
Run multiple types of analysis over the same data, grouped by the specified field.
|
|
QueryMultiAnalysisInterval ( string collection, IEnumerable |
Run multiple types of analysis over the same data. Each item represents one interval.
|
|
QueryMultiAnalysisIntervalAsync ( string collection, IEnumerable |
Run multiple types of analysis over the same data. Each item represents one interval.
|
|
QueryMultiAnalysisIntervalGroup ( string collection, IEnumerable |
||
QueryMultiAnalysisIntervalGroupAsync ( string collection, IEnumerable |
||
SendCachedEvents ( ) : void |
Submit all events found in the event cache. If an events are rejected by the server, KeenCacheException will be thrown with a listing of the rejected events, each with the error message it received.
|
|
SendCachedEventsAsync ( ) : System.Threading.Tasks.Task |
Submit all events found in the event cache. If an events are rejected by the server, KeenCacheException will be thrown with a listing of the rejected events, each with the error message it received.
|
Method | Description | |
---|---|---|
AddEventsBulkAsync ( string collection, IEnumerable |
Add a collection of events to the specified collection. Assumes that objects in the collection have already been through AddEvent to receive global properties.
|
|
ExecDynamicPropertyValue ( string propName, IDynamicPropertyValue dynProp ) : void | ||
PrepareUserObject ( object eventInfo, IEnumerable |
Convert a user-supplied object to a JObject that can be sent to the Keen.IO API. This writes any global properties to the object and records the time.
|
public AddEvent ( string collection, object eventInfo, IEnumerable |
||
collection | string | Collection name |
eventInfo | object | An object representing the event to be added. |
addOns | IEnumerable |
Optional collection of Data Enhancement Add-ons |
return | void |
public AddEventAsync ( string collection, object eventInfo, IEnumerable |
||
collection | string | Collection name |
eventInfo | object | The event to add. |
addOns | IEnumerable |
Optional collection of Data Enhancement Add-ons |
return | System.Threading.Tasks.Task |
public AddEvents ( string collection, IEnumerable | ||
collection | string | Collection name |
eventsInfo | IEnumerable | Collection of events to add |
addOns | IEnumerable |
Optional collection of Data Enhancement Add-ons |
return | void |
public AddEventsAsync ( string collection, IEnumerable | ||
collection | string | Collection name |
eventsInfo | IEnumerable | Collection of events to add |
addOns | IEnumerable |
Optional collection of Data Enhancement Add-ons |
return | System.Threading.Tasks.Task |
public AddGlobalProperty ( string property, object value ) : void | ||
property | string | Property name |
value | object | Property value. This may be a simple value, array, or object, /// or an object that supports IDynamicPropertyValue returning one of those. |
return | void |
public DeleteCollection ( string collection ) : void | ||
collection | string | Name of collection to delete. |
return | void |
public DeleteCollectionAsync ( string collection ) : System.Threading.Tasks.Task | ||
collection | string | Name of collection to delete. |
return | System.Threading.Tasks.Task |
public GetSchema ( string collection ) : dynamic | ||
collection | string | |
return | dynamic |
public GetSchemaAsync ( string collection ) : Task |
||
collection | string | |
return | Task |
public GetSchemas ( ) : Newtonsoft.Json.Linq.JArray | ||
return | Newtonsoft.Json.Linq.JArray |
public KeenClient ( IProjectSettings prjSettings ) : Keen.Core.DataEnrichment | ||
prjSettings | IProjectSettings | A ProjectSettings instance containing the ProjectId and API keys |
return | Keen.Core.DataEnrichment |
public KeenClient ( IProjectSettings prjSettings, IEventCache eventCache ) : Keen.Core.DataEnrichment | ||
prjSettings | IProjectSettings | A ProjectSettings instance containing the ProjectId and API keys |
eventCache | IEventCache | An IEventCache instance providing a caching strategy |
return | Keen.Core.DataEnrichment |
public Query ( string queryName, string>.Dictionary |
||
queryName | string | Query name, e.g., KeenConstants.QueryCount |
parms | string>.Dictionary | Parameters for query, API keys are not required here. |
return | Newtonsoft.Json.Linq.JObject |
public Query ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, QueryTimeframe timeframe = null, IEnumerable |
||
queryType | Keen.Core.Query.QueryType | Type of query to run. |
collection | string | Name of event collection to query. |
targetProperty | string | Name of property to analyse. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
filters | IEnumerable |
Filter to narrow down the events used in analysis. Optional, may be null. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | string |
public QueryAsync ( string queryName, string>.Dictionary |
||
queryName | string | |
parms | string>.Dictionary | |
return | Task |
public QueryAsync ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, QueryTimeframe timeframe = null, IEnumerable |
||
queryType | Keen.Core.Query.QueryType | Type of query to run. |
collection | string | Name of event collection to query. |
targetProperty | string | Name of property to analyse. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
filters | IEnumerable |
Filter to narrow down the events used in analysis. Optional, may be null. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | Task |
public QueryExtractResource ( string collection, QueryTimeframe timeframe = null, IEnumerable |
||
collection | string | Name of event collection to query. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
filters | IEnumerable |
Filter to narrow down the events used in analysis. Optional, may be null. |
latest | int | Request up to 100 of the most recent events added to a given collection. |
string | If specified, email will be sent when the data is ready for download. Otherwise, it will be returned directly. | |
return | IEnumerable |
public QueryExtractResourceAsync ( string collection, QueryTimeframe timeframe = null, IEnumerable |
||
collection | string | Name of event collection to query. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
filters | IEnumerable |
Filter to narrow down the events used in analysis. Optional, may be null. |
latest | int | Request up to 100 of the most recent events added to a given collection. |
string | If specified, email will be sent when the data is ready for download. Otherwise, it will be returned directly. | |
return | Task |
public QueryFunnel ( IEnumerable |
||
steps | IEnumerable |
Analysis steps for funnel. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | Keen.Core.Query.FunnelResult |
public QueryFunnelAsync ( IEnumerable |
||
steps | IEnumerable |
Analysis steps for funnel. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | Task |
public QueryGroup ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, string groupBy, QueryTimeframe timeframe = null, IEnumerable |
||
queryType | Keen.Core.Query.QueryType | Type of query to run. |
collection | string | Name of event collection to query. |
targetProperty | string | Name of property to analyse. |
groupBy | string | Name of a collection field by which to group results. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
filters | IEnumerable |
Filter to narrow down the events used in analysis. Optional, may be null. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | IEnumerable |
public QueryGroupAsync ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, string groupBy, QueryTimeframe timeframe = null, IEnumerable |
||
queryType | Keen.Core.Query.QueryType | Type of query to run. |
collection | string | Name of event collection to query. |
targetProperty | string | Name of property to analyse. |
groupBy | string | Name of a collection field by which to group results. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
filters | IEnumerable |
Filter to narrow down the events used in analysis. Optional, may be null. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | Task |
public QueryInterval ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, QueryTimeframe timeframe, Keen.Core.Query.QueryInterval interval = null, IEnumerable |
||
queryType | Keen.Core.Query.QueryType | Type of query to run. |
collection | string | Name of event collection to query. |
targetProperty | string | Name of property to analyse. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
interval | Keen.Core.Query.QueryInterval | The block size for partitioning the specified timeframe. Optional, may be null. |
filters | IEnumerable |
Filters to narrow down the events used in analysis. Optional, may be null. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | IEnumerable |
public QueryIntervalAsync ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, QueryTimeframe timeframe, Keen.Core.Query.QueryInterval interval = null, IEnumerable |
||
queryType | Keen.Core.Query.QueryType | Type of query to run. |
collection | string | Name of event collection to query. |
targetProperty | string | Name of property to analyse. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
interval | Keen.Core.Query.QueryInterval | The block size for partitioning the specified timeframe. Optional, may be null. |
filters | IEnumerable |
Filters to narrow down the events used in analysis. Optional, may be null. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | Task |
public QueryIntervalGroup ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, string groupBy, QueryTimeframe timeframe, Keen.Core.Query.QueryInterval interval, IEnumerable |
||
queryType | Keen.Core.Query.QueryType | Type of query to run. |
collection | string | Name of event collection to query. |
targetProperty | string | Name of property to analyse. |
groupBy | string | Name of field by which to group results. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
interval | Keen.Core.Query.QueryInterval | The block size for partitioning the specified timeframe. Optional, may be null. |
filters | IEnumerable |
Filters to narrow down the events used in analysis. Optional, may be null. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | IEnumerable |
public QueryIntervalGroupAsync ( Keen.Core.Query.QueryType queryType, string collection, string targetProperty, string groupBy, QueryTimeframe timeframe, Keen.Core.Query.QueryInterval interval, IEnumerable |
||
queryType | Keen.Core.Query.QueryType | Type of query to run. |
collection | string | Name of event collection to query. |
targetProperty | string | Name of property to analyse. |
groupBy | string | Name of field by which to group results. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
interval | Keen.Core.Query.QueryInterval | The block size for partitioning the specified timeframe. Optional, may be null. |
filters | IEnumerable |
Filters to narrow down the events used in analysis. Optional, may be null. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | Task |
public QueryMultiAnalysis ( string collection, IEnumerable |
||
collection | string | Name of event collection to query. |
analysisParams | IEnumerable |
Defines the multiple types of analyses to perform. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
filters | IEnumerable |
Filter to narrow down the events used in analysis. Optional, may be null. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | string>.IDictionary |
public QueryMultiAnalysisAsync ( string collection, IEnumerable |
||
collection | string | Name of event collection to query. |
analysisParams | IEnumerable |
Defines the multiple types of analyses to perform. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
filters | IEnumerable |
Filter to narrow down the events used in analysis. Optional, may be null. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | string>>.Task |
public QueryMultiAnalysisGroup ( string collection, IEnumerable |
||
collection | string | Name of event collection to query. |
analysisParams | IEnumerable |
Defines the multiple types of analyses to perform. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
filters | IEnumerable |
Filter to narrow down the events used in analysis. Optional, may be null. |
groupBy | string | Name of a collection field by which to group results. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | string>>>.IEnumerable |
public QueryMultiAnalysisGroupAsync ( string collection, IEnumerable |
||
collection | string | Name of event collection to query. |
analysisParams | IEnumerable |
Defines the multiple types of analyses to perform. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
filters | IEnumerable |
Filter to narrow down the events used in analysis. Optional, may be null. |
groupBy | string | Name of a collection field by which to group results. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | string>>>>.Task |
public QueryMultiAnalysisInterval ( string collection, IEnumerable |
||
collection | string | Name of event collection to query. |
analysisParams | IEnumerable |
Defines the multiple types of analyses to perform. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
interval | Keen.Core.Query.QueryInterval | The block size for partitioning the specified timeframe. Optional, may be null. |
filters | IEnumerable |
Filters to narrow down the events used in analysis. Optional, may be null. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | string>>>.IEnumerable |
public QueryMultiAnalysisIntervalAsync ( string collection, IEnumerable |
||
collection | string | Name of event collection to query. |
analysisParams | IEnumerable |
Defines the multiple types of analyses to perform. |
timeframe | QueryTimeframe | Specifies window of time from which to select events for analysis. May be absolute or relative. |
interval | Keen.Core.Query.QueryInterval | The block size for partitioning the specified timeframe. Optional, may be null. |
filters | IEnumerable |
Filters to narrow down the events used in analysis. Optional, may be null. |
timezone | string | The timezone to use when specifying a relative timeframe. Optional, may be blank. |
return | string>>>>.Task |
public QueryMultiAnalysisIntervalGroup ( string collection, IEnumerable |
||
collection | string | |
analysisParams | IEnumerable |
|
timeframe | QueryTimeframe | |
interval | Keen.Core.Query.QueryInterval | |
filters | IEnumerable |
|
groupBy | string | |
timezone | string | |
return | string>>>>>.IEnumerable |
public QueryMultiAnalysisIntervalGroupAsync ( string collection, IEnumerable |
||
collection | string | |
analysisParams | IEnumerable |
|
timeframe | QueryTimeframe | |
interval | Keen.Core.Query.QueryInterval | |
filters | IEnumerable |
|
groupBy | string | |
timezone | string | |
return | string>>>>>>.Task |
public SendCachedEventsAsync ( ) : System.Threading.Tasks.Task | ||
return | System.Threading.Tasks.Task |