algoliasearch-scala
API
Generated with
algoliasearch-scala/algoliasearch/algoliasearch.api/InsightsClient

InsightsClient

algoliasearch.api.InsightsClient
See theInsightsClient companion object
class InsightsClient(appId: String, apiKey: String, region: Option[String], clientOptions: ClientOptions) extends ApiClient

Attributes

Companion
object
Graph
Supertypes
class ApiClient
trait AutoCloseable
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def customDelete[T : Manifest](path: String, parameters: Option[Map[String, Any]], requestOptions: Option[RequestOptions])(implicit evidence$1: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customGet[T : Manifest](path: String, parameters: Option[Map[String, Any]], requestOptions: Option[RequestOptions])(implicit evidence$2: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customPost[T : Manifest](path: String, parameters: Option[Map[String, Any]], body: Option[Any], requestOptions: Option[RequestOptions])(implicit evidence$3: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

body

Parameters to send with the custom request.

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customPut[T : Manifest](path: String, parameters: Option[Map[String, Any]], body: Option[Any], requestOptions: Option[RequestOptions])(implicit evidence$4: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

body

Parameters to send with the custom request.

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def deleteUserToken(userToken: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[Unit]

Deletes all events related to the specified user token from events metrics and analytics. To delete a personalization user profile, see Delete a user profile.

Deletes all events related to the specified user token from events metrics and analytics. To delete a personalization user profile, see Delete a user profile.

Value parameters

userToken

User token for which to delete all associated events.

Attributes

def pushEvents(insightsEvents: InsightsEvents, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[EventsResponse]

Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.

Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.

Attributes

Inherited methods

override def close(): Unit

Attributes

Definition Classes
ApiClient -> AutoCloseable
Inherited from:
ApiClient
Generated with