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 e.g. by setting the masterKey field in 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"
}
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 masterKey: String

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

  3. abstract val projectId: String

    Definition Classes
    AccessLevel

  4. abstract val scheme: String

    Definition Classes
    AccessLevel

  5. 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. 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

  7. 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

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. 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

  10. def clone(): AnyRef

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

  11. 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

  12. 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

  13. 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.

  14. 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.

  15. 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

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

    Definition Classes
    AnyRef

  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  18. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  20. 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.

  21. 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.

  22. 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.

  23. 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.

  24. 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.

  25. 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.

  26. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  27. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  28. 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

  29. 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

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

    Definition Classes
    AnyRef

  31. final def notify(): Unit

    Definition Classes
    AnyRef

  32. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  33. lazy val readKey: String

    Definition Classes
    Master → Reader

  34. 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

  35. 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

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

    Definition Classes
    AnyRef

  37. def toString(): String

    Definition Classes
    AnyRef → Any

  38. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. lazy val writeKey: String

    Definition Classes
    Master → Writer

Inherited from Writer

Inherited from Reader

Inherited from AccessLevel

Inherited from AnyRef

Inherited from Any

Ungrouped