package
responses
Type Members
-
case class
ABTestResponse(abTestID: Int, clickSignificance: Option[Int], conversionSignificance: Option[Float], createdAt: LocalDateTime, endAt: LocalDateTime, name: String, status: String, variants: Seq[VariantResponse]) extends Product with Serializable
-
case class
ABTestTask(abTestID: Int, taskID: Long, index: String) extends AlgoliaTask with Product with Serializable
-
case class
ABTestsResponse(abtests: Seq[ABTestResponse], count: Int, total: Int) extends Product with Serializable
-
-
sealed
trait
AlgoliaTask extends AnyRef
-
case class
AllKeys(keys: Seq[ApiKey]) extends Product with Serializable
-
case class
Alternative(type: Option[String], words: Option[Seq[String]], typos: Option[Long], offset: Option[Long], length: Option[Long]) extends Product with Serializable
-
case class
BrowseResult(cursor: Option[String], hits: Seq[JObject], processingTimeMS: Option[Int], query: Option[String], params: Option[String], nbHits: Option[Int], page: Option[Int], histPerPage: Option[Int], nbPages: Option[Int]) extends Product with Serializable
-
case class
ClusterData(clusterName: String, nbRecords: Int, nbUserIDs: Int, dataSize: Int) extends Product with Serializable
-
case class
ClusterList(clusters: Seq[ClusterData]) extends Product with Serializable
-
case class
CreateUpdateKey(key: String, createdAt: Option[String]) extends Product with Serializable
-
case class
Created(createdAt: String) extends Product with Serializable
-
case class
DeleteKey(deletedAt: String) extends Product with Serializable
-
case class
DeletePersonalizationProfileResponse(userToken: String, deletedUntil: String) extends Product with Serializable
-
case class
Deleted(deletedAt: String) extends Product with Serializable
-
case class
DictionaryTask(taskID: Long, updatedAt: Option[String] = None) extends AlgoliaAppTask with Product with Serializable
-
case class
Explain(match: Option[QueryMatch], params: Option[Map[String, AnyRef]]) extends Product with Serializable
-
case class
FacetHit(value: String, highlighted: String, count: Int) extends Product with Serializable
-
case class
GetObject(res: JObject) extends Product with Serializable
-
case class
GetStrategyResponse(eventsScoring: Option[Seq[EventsScoring]], facetsScoring: Option[Seq[FacetsScoring]], personalizationImpact: Option[Int]) extends Product with Serializable
-
case class
HasPendingMappings(pending: Boolean, clusters: Option[Map[String, Seq[String]]]) extends Product with Serializable
-
case class
HighlightResult(value: String, matchLevel: String, matchedWords: Iterable[String], fullyHighlighted: Option[Boolean]) extends Product with Serializable
-
-
case class
HitsWithPosition[T](hit: T, page: Int, position: Int) extends Product with Serializable
-
case class
Index(name: String, createdAt: String, updatedAt: String, entries: Int, dataSize: Int, fileSize: Int, lastBuildTimeS: Int, numberOfPendingTasks: Int, pendingTask: Boolean, primary: Option[String] = None) extends Product with Serializable
-
case class
Indices(items: Seq[Index], nbPages: Int) extends Product with Serializable
-
case class
InnerQuery(index_name: String, query_id: Option[String], offset: Option[Int], user_token: Option[String]) extends Product with Serializable
-
case class
InsightsEventResponse(status: Int, message: String) extends Product with Serializable
-
case class
Log(timestamp: String, method: String, answer_code: String, query_body: String, answer: String, url: String, ip: String, query_headers: String, sha1: String, nb_api_calls: String, processing_time_ms: String, index: Option[String], query_nb_hits: Option[String], exhaustive: Option[Boolean], inner_queries: Seq[InnerQuery]) extends Product with Serializable
-
sealed
trait
LogType extends AnyRef
-
case class
Logs(logs: Seq[Log]) extends Product with Serializable
-
case class
MultiQueriesResult(results: Seq[SearchResult]) extends Product with Serializable
-
trait
ObjectID extends AnyRef
-
case class
PersonalizationProfileResponse(userToken: String, lastEventAt: String, scores: Map[String, Any]) extends Product with Serializable
-
case class
QueryMatch(alternatives: Option[Seq[Alternative]]) extends Product with Serializable
-
case class
RankingInfo(nbTypos: Int, firstMatchedWord: Int, proximityDistance: Int, userScore: Int, geoDistance: Int, geoPrecision: Int, nbExactWords: Int, words: Int, filters: Int, promoted: Option[Boolean], matchedGeoLocation: Option[Map[String, Float]]) extends Product with Serializable
-
case class
RestoreKey(createdAt: Option[String]) extends Product with Serializable
-
case class
Results(results: Seq[JObject]) extends Product with Serializable
-
case class
SearchDictionaryResult(hits: Seq[JObject], nbHits: Int, page: Int, nbPages: Int) extends Product with Serializable
-
case class
SearchFacetResult(facetHits: List[FacetHit], exhaustiveFacetsCount: Option[Boolean], processingTimeMS: Option[Int]) extends Product with Serializable
-
case class
SearchResult(hits: Seq[JObject], nbHits: Option[Int], processingTimeMS: Option[Int] = None, hitsPerPage: Option[Int], page: Option[Int], nbPages: Option[Int], offset: Option[Int], length: Option[Int], facets: Option[Map[String, Map[String, Int]]], exhaustiveFacetsCount: Option[Boolean], exhaustiveNbHits: Option[Boolean], query: Option[String], queryAfterRemoval: Option[String], params: Option[String], message: Option[String], aroundLatLng: Option[String], automaticRadius: Option[String], facets_stats: Option[Map[String, Float]], serverUsed: Option[String], parsedQuery: Option[String], appliedRules: Option[Map[String, String]], processed: Option[Boolean], index: Option[String], explain: Option[Explain], appliedRelevancyStrictness: Option[Integer], nbSortedHits: Option[Int], renderingContent: Option[RenderingContent]) extends Product with Serializable
-
case class
SearchRuleResult(hits: Seq[Rule], nbHits: Int) extends SearchHits[Rule] with Product with Serializable
-
-
case class
SearchUserID(hits: Seq[UserIDHit], nbHits: Int, page: Int, hitsPerPage: Int, updatedAt: Int) extends Product with Serializable
-
case class
SetStrategyResponse(status: Int, message: String) extends Product with Serializable
-
case class
SetStrategyResult(updatedAt: String) extends Product with Serializable
-
case class
SnippetResult(value: String, matchLevel: String) extends Product with Serializable
-
case class
SynonymTask(taskID: Long, id: Option[String], updatedAt: Option[String] = None) extends AlgoliaTask with Product with Serializable
-
case class
Task(taskID: Long, createdAt: Option[String] = None, updatedAt: Option[String] = None) extends AlgoliaTask with Product with Serializable
-
case class
TaskIndexing(taskID: Long, objectID: String, createdAt: Option[String] = None) extends AlgoliaTask with Product with Serializable
-
case class
TaskStatus(status: String, pendingTask: Boolean) extends Product with Serializable
-
case class
TasksMultipleIndex(taskID: Map[String, Long], objectIDs: Seq[String], createdAt: Option[String]) extends AlgoliaTask with Product with Serializable
-
case class
TasksSingleIndex(taskID: Long, objectIDs: Seq[String], createdAt: Option[String] = None) extends AlgoliaTask with Product with Serializable
-
case class
TopUserID(topUsers: Map[String, UserData]) extends Product with Serializable
-
case class
UserData(userID: String, nbRecords: Int, dataSize: Int) extends Product with Serializable
-
case class
UserDataWithCluster(userID: String, clusterName: String, nbRecords: Int, dataSize: Int) extends Product with Serializable
-
case class
UserIDHit(userID: String, clusterName: String, nbRecords: Int, dataSize: Int, objectID: String, _highlightResult: Map[String, HighlightResult]) extends Product with Serializable
-
case class
UserIDList(userIDs: Seq[UserDataWithCluster], page: Int, hitsPerPage: Int) extends Product with Serializable
-
case class
VariantResponse(averageClickPosition: Option[Float], clickCount: Option[Int], clickThroughRate: Option[Float], conversionCount: Option[Int], conversionRate: Option[Float], description: String, index: String, noResultCount: Option[Int], searchCount: Option[Int], trafficPercentage: Int, userCount: Option[Int], customSearchParameters: Option[Query], trackedSearchCount: Option[Int]) extends Product with Serializable
Value Members
-
object
LogType extends Product with Serializable
Delete the user profile response.
the user token representing the user and associated data
date until which the data can safely be considered as deleted for the given use