io.keen.client.scala

Master

trait Master extends Reader with Writer

A Client mixing in Master can make Keen IO API calls requiring a master key, such as deleting data, creating saved queries, and performing administrative functions.

A Master client can also perform all Reader and Writer API calls and does not require additional keys configured for these. However, this should not be considered a shortcut! Please keep your master key as secure as possible by not deploying it where it isn't strictly needed.

A master key must be configured in the Client's Settings or the masterKey field must otherwise be set e.g. with an anonymous class override.

Self Type
Master with Client
Example:

  1. Initializing a Client with master access

    val keen = new Client with Master {
override val masterKey = "myMasterKey"
}
Exceptions thrown
MissingCredential

if a master key is not configured.

See also

https://keen.io/docs/security/

Linear Supertypes
Writer, Reader, AccessLevel, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Master
  2. Writer
  3. Reader
  4. AccessLevel
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val authority: String

    Definition Classes
    AccessLevel

  2. abstract val scheme: String

    Definition Classes
    AccessLevel

  3. abstract val version: String

    Definition Classes
    AccessLevel

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. val MaxSendIntervalEvents: Long

    Attributes
    protected
    Definition Classes
    Writer

  7. val MaxSendIntervalSeconds: Long

    Attributes
    protected
    Definition Classes
    Writer

  8. val MinSendIntervalEvents: Long

    Attributes
    protected
    Definition Classes
    Writer

  9. val MinSendIntervalSeconds: Long

    Attributes
    protected
    Definition Classes
    Writer

  10. def addEvent(collection: String, event: String): Future[Response]

    Publish a single event.

    Publish a single event. See Event Collection Resource.

    collection

    The collection to which the event will be added.

    event

    The event

    Definition Classes
    Writer

  11. def addEvents(events: String): Future[Response]

    Publish multiple events.

    Publish multiple events. See Event Resource.

    events

    The events to add to the project.

    Definition Classes
    Writer

  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  13. def average(collection: String, targetProperty: String, filters: Option[String] = None, timeframe: Option[String] = None, timezone: Option[String] = None, groupBy: Option[String] = None): Future[Response]

    Returns the average across all numeric values for the target property in the event collection matching the given criteria.

    Returns the average across all numeric values for the target property in the event collection matching the given criteria. See Average Resource.

    collection

    The name of the event collection you are analyzing.

    targetProperty

    The name of the property you are analyzing.

    filters

    Filters are used to narrow down the events used in an analysis request based on event property values. See Filters.

    timeframe

    A Timeframe specifies the events to use for analysis based on a window of time. If no timeframe is specified, all events will be counted. See Timeframes.

    timezone

    Modifies the timeframe filters for Relative Timeframes to match a specific timezone.

    groupBy

    The group_by parameter specifies the name of a property by which you would like to group the results. Using this parameter changes the response format. See Group By.

    Definition Classes
    Reader

  14. val batchSize: Integer

    Definition Classes
    Writer

  15. val batchTimeout: Integer

    Definition Classes
    Writer

  16. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  17. def count(collection: String, filters: Option[String] = None, timeframe: Option[String] = None, timezone: Option[String] = None, groupBy: Option[String] = None): Future[Response]

    Returns the number of resources in the event collection matching the given criteria.

    Returns the number of resources in the event collection matching the given criteria. See Event Resource.

    collection

    The name of the event collection you are analyzing.

    filters

    Filters are used to narrow down the events used in an analysis request based on event property values. See Filters.

    timeframe

    A Timeframe specifies the events to use for analysis based on a window of time. If no timeframe is specified, all events will be counted. See Timeframes.

    Definition Classes
    Reader

  18. def countUnique(collection: String, targetProperty: String, filters: Option[String] = None, timeframe: Option[String] = None, timezone: Option[String] = None, groupBy: Option[String] = None): Future[Response]

    Returns the number of unique resources in the event collection matching the given criteria.

    Returns the number of unique resources in the event collection matching the given criteria. See Event Resource.

    collection

    The name of the event collection you are analyzing.

    targetProperty

    The name of the property you are analyzing.

    filters

    Filters are used to narrow down the events used in an analysis request based on event property values. See Filters.

    timeframe

    A Timeframe specifies the events to use for analysis based on a window of time. If no timeframe is specified, all events will be counted. See Timeframes.

    timezone

    Modifies the timeframe filters for Relative Timeframes to match a specific timezone.

    groupBy

    The group_by parameter specifies the name of a property by which you would like to group the results. Using this parameter changes the response format. See Group By.

    Definition Classes
    Reader

  19. def deleteCollection(collection: String): Future[Response]

    Deletes the entire event collection.

    Deletes the entire event collection. This is irreversible and will only work for collections under 10k events. See Event Collection Resource.

    collection

    The name of the collection.

  20. def deleteProperty(collection: String, name: String): Future[Response]

    Removes a property and deletes all values stored with that property name.

    Removes a property and deletes all values stored with that property name. See Property Resource.

  21. def doRequest(path: String, method: String, key: String, body: Option[String] = None, params: Map[String, Option[String]] = Map.empty): Future[Response]

    Attributes
    protected
    Definition Classes
    AccessLevel

  22. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  23. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  24. val eventStore: EventStore

    Definition Classes
    Writer

  25. def extraction(collection: String, filters: Option[String] = None, timeframe: Option[String] = None, email: Option[String] = None, latest: Option[String] = None, propertyNames: Option[String] = None): Future[Response]

    Definition Classes
    Reader

  26. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  27. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  28. def getCollection(collection: String): Future[Response]

    Returns available schema information for this event collection, including properties and their type.

    Returns available schema information for this event collection, including properties and their type. It also returns links to sub-resources. See Event Collection Resource.

    collection

    The name of the collection.

  29. def getEvents: Future[Response]

    Returns schema information for all the event collections in this project.

    Returns schema information for all the event collections in this project. See Event Resource.

  30. def getProject: Future[Response]

    Returns detailed information about the specific project, as well as links to related resources.

    Returns detailed information about the specific project, as well as links to related resources. See Project Row Resource.

  31. def getProjects: Future[Response]

    Returns the projects accessible to the API user, as well as links to project sub-resources for discovery.

    Returns the projects accessible to the API user, as well as links to project sub-resources for discovery. See Projects Resource.

  32. def getProperty(collection: String, name: String): Future[Response]

    Returns the property name, type, and a link to sub-resources.

    Returns the property name, type, and a link to sub-resources. See Property Resource.

  33. def getQueries: Future[Response]

    Returns the list of available queries and links to them.

    Returns the list of available queries and links to them. See Queries Resource.

  34. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  35. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  36. val masterKey: String

    A master key required to make API calls of administrative nature.

  37. def maximum(collection: String, targetProperty: String, filters: Option[String] = None, timeframe: Option[String] = None, timezone: Option[String] = None, groupBy: Option[String] = None): Future[Response]

    Returns the maximum numeric value for the target property in the event collection matching the given criteria.

    Returns the maximum numeric value for the target property in the event collection matching the given criteria. See Maximum Resource.

    collection

    The name of the event collection you are analyzing.

    targetProperty

    The name of the property you are analyzing.

    filters

    Filters are used to narrow down the events used in an analysis request based on event property values. See Filters.

    timeframe

    A Timeframe specifies the events to use for analysis based on a window of time. If no timeframe is specified, all events will be counted. See Timeframes.

    timezone

    Modifies the timeframe filters for Relative Timeframes to match a specific timezone.

    groupBy

    The group_by parameter specifies the name of a property by which you would like to group the results. Using this parameter changes the response format. See Group By.

    Definition Classes
    Reader

  38. def minimum(collection: String, targetProperty: String, filters: Option[String] = None, timeframe: Option[String] = None, timezone: Option[String] = None, groupBy: Option[String] = None): Future[Response]

    Returns the minimum numeric value for the target property in the event collection matching the given criteria.

    Returns the minimum numeric value for the target property in the event collection matching the given criteria. See Minimum Resource.

    collection

    The name of the event collection you are analyzing.

    targetProperty

    The name of the property you are analyzing.

    filters

    Filters are used to narrow down the events used in an analysis request based on event property values. See Filters.

    timeframe

    A Timeframe specifies the events to use for analysis based on a window of time. If no timeframe is specified, all events will be counted. See Timeframes.

    timezone

    Modifies the timeframe filters for Relative Timeframes to match a specific timezone.

    groupBy

    The group_by parameter specifies the name of a property by which you would like to group the results. Using this parameter changes the response format. See Group By.

    Definition Classes
    Reader

  39. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  40. final def notify(): Unit

    Definition Classes
    AnyRef

  41. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  42. val projectId: String

    Definition Classes
    AccessLevel

  43. def queueEvent(collection: String, event: String): Unit

    Queue events locally for subsequent publishing.

    Queue events locally for subsequent publishing.

    collection

    The collection to which the event will be added.

    event

    The event

    Definition Classes
    Writer

  44. val readKey: String

    A read key required to make API calls for querying and extracting data.

    A read key required to make API calls for querying and extracting data.

    Definition Classes
    Master → Reader

  45. val scheduledThreadPool: Option[ScheduledThreadPoolExecutor]

    Schedule sending of queued events.

    Schedule sending of queued events.

    Attributes
    protected
    Definition Classes
    Writer

  46. def selectUnique(collection: String, targetProperty: String, filters: Option[String] = None, timeframe: Option[String] = None, timezone: Option[String] = None, groupBy: Option[String] = None): Future[Response]

    Returns a list of unique resources in the event collection matching the given criteria.

    Returns a list of unique resources in the event collection matching the given criteria. See Select Unique Resource.

    collection

    The name of the event collection you are analyzing.

    targetProperty

    The name of the property you are analyzing.

    filters

    Filters are used to narrow down the events used in an analysis request based on event property values. See Filters.

    timeframe

    A Timeframe specifies the events to use for analysis based on a window of time. If no timeframe is specified, all events will be counted. See Timeframes.

    timezone

    Modifies the timeframe filters for Relative Timeframes to match a specific timezone.

    groupBy

    The group_by parameter specifies the name of a property by which you would like to group the results. Using this parameter changes the response format. See Group By.

    Definition Classes
    Reader

  47. val sendIntervalEvents: Integer

    Definition Classes
    Writer

  48. val sendIntervalSeconds: Integer

    Definition Classes
    Writer

  49. def sendQueuedEvents(): Unit

    Sends all queued events, removing events from the queue as events are successfully sent.

    Sends all queued events, removing events from the queue as events are successfully sent.

    Definition Classes
    Writer

  50. def sendQueuedEventsAsync(): Unit

    Asynchronously sends all queued events.

    Asynchronously sends all queued events.

    Definition Classes
    Writer

  51. def shutdown(): Unit

    Safely shuts down scheduledThreadPool before sending all events remaining in eventStore.

    Safely shuts down scheduledThreadPool before sending all events remaining in eventStore.

    Definition Classes
    Writer

  52. val shutdownDelay: Integer

    Definition Classes
    Writer

  53. def sum(collection: String, targetProperty: String, filters: Option[String] = None, timeframe: Option[String] = None, timezone: Option[String] = None, groupBy: Option[String] = None): Future[Response]

    Returns the sum across all numeric values for the target property in the event collection matching the given criteria.

    Returns the sum across all numeric values for the target property in the event collection matching the given criteria. See Sum Resource.

    collection

    The name of the event collection you are analyzing.

    targetProperty

    The name of the property you are analyzing.

    filters

    Filters are used to narrow down the events used in an analysis request based on event property values. See Filters.

    timeframe

    A Timeframe specifies the events to use for analysis based on a window of time. If no timeframe is specified, all events will be counted. See Timeframes.

    timezone

    Modifies the timeframe filters for Relative Timeframes to match a specific timezone.

    groupBy

    The group_by parameter specifies the name of a property by which you would like to group the results. Using this parameter changes the response format. See Group By.

    Definition Classes
    Reader

  54. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  55. def toString(): String

    Definition Classes
    AnyRef → Any

  56. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  57. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  58. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  59. val writeKey: String

    A write key required to make API calls that write data.

    A write key required to make API calls that write data.

    Definition Classes
    Master → Writer

Inherited from Writer

Inherited from Reader

Inherited from AccessLevel

Inherited from AnyRef

Inherited from Any

Ungrouped