io.keen.client.scala

Reader

trait Reader extends AccessLevel

A Client mixing in Reader can make Keen IO API calls requiring a read key.

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

Self Type
Reader with Client
Example:

  1. Initializing a Client with read access

    val keen = new Client with Reader {
override val readKey = "myReadKey"
}
Exceptions thrown
MissingCredential

if a read key is not configured.

See also

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

Linear Supertypes
AccessLevel, AnyRef, Any
Known Subclasses
Master
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Reader
  2. AccessLevel
  3. AnyRef
  4. 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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

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

  8. def clone(): AnyRef

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

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

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

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

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

    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

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

  15. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

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

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

    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  24. val projectId: String

    Definition Classes
    AccessLevel

  25. val readKey: String

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

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

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

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

    Definition Classes
    AnyRef

  29. def toString(): String

    Definition Classes
    AnyRef → Any

  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AccessLevel

Inherited from AnyRef

Inherited from Any

Ungrouped