responses

Type Members

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

   

2. case class ABTestTask(abTestID: Int, taskID: Long, index: String) extends AlgoliaTask with Product with Serializable

   

3. case class ABTestsResponse(abtests: Seq[ABTestResponse], count: Int, total: Int) extends Product with Serializable

   

4. sealed trait AlgoliaAppTask extends AnyRef

   

5. sealed trait AlgoliaTask extends AnyRef

   

6. case class AllKeys(keys: Seq[ApiKey]) extends Product with Serializable

   

7. case class Alternative(type: Option[String], words: Option[Seq[String]], typos: Option[Long], offset: Option[Long], length: Option[Long]) extends Product with Serializable

   

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

   

9. case class ClusterData(clusterName: String, nbRecords: Int, nbUserIDs: Int, dataSize: Int) extends Product with Serializable

   

10. case class ClusterList(clusters: Seq[ClusterData]) extends Product with Serializable

    

11. case class CreateUpdateKey(key: String, createdAt: Option[String]) extends Product with Serializable

    

12. case class Created(createdAt: String) extends Product with Serializable

    

13. case class DeleteKey(deletedAt: String) extends Product with Serializable

    

14. case class DeletePersonalizationProfileResponse(userToken: String, deletedUntil: String) extends Product with Serializable

    

    Delete the user profile response.

    Delete the user profile response.

    userToken

    the user token representing the user and associated data

    deletedUntil

    date until which the data can safely be considered as deleted for the given use

15. case class Deleted(deletedAt: String) extends Product with Serializable

    

16. case class DictionaryTask(taskID: Long, updatedAt: Option[String] = None) extends AlgoliaAppTask with Product with Serializable

    

17. case class Explain(match: Option[QueryMatch], params: Option[Map[String, AnyRef]]) extends Product with Serializable

    

18. case class FacetHit(value: String, highlighted: String, count: Int) extends Product with Serializable

    

19. case class GetObject(res: JObject) extends Product with Serializable

    

20. case class GetStrategyResponse(eventsScoring: Option[Seq[EventsScoring]], facetsScoring: Option[Seq[FacetsScoring]], personalizationImpact: Option[Int]) extends Product with Serializable

    

21. case class HasPendingMappings(pending: Boolean, clusters: Option[Map[String, Seq[String]]]) extends Product with Serializable

    

22. case class HighlightResult(value: String, matchLevel: String, matchedWords: Iterable[String], fullyHighlighted: Option[Boolean]) extends Product with Serializable

    

23. trait Hit extends ObjectID

    

24. case class HitsWithPosition[T](hit: T, page: Int, position: Int) extends Product with Serializable

    

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

    

26. case class Indices(items: Seq[Index], nbPages: Int) extends Product with Serializable

    

27. case class InnerQuery(index_name: String, query_id: Option[String], offset: Option[Int], user_token: Option[String]) extends Product with Serializable

    

28. case class InsightsEventResponse(status: Int, message: String) extends Product with Serializable

    

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

    

30. sealed trait LogType extends AnyRef

    

31. case class Logs(logs: Seq[Log]) extends Product with Serializable

    

32. case class MultiQueriesResult(results: Seq[SearchResult]) extends Product with Serializable

    

33. trait ObjectID extends AnyRef

    

34. case class PersonalizationProfileResponse(userToken: String, lastEventAt: String, scores: Map[String, Any]) extends Product with Serializable

    

    User profile built from Personalization strategy.

    User profile built from Personalization strategy.

    userToken

    the user token representing the user and associated data

    lastEventAt

    the last processed event timestamp using the ISO 8601 format.

    scores

    The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20.

35. case class QueryMatch(alternatives: Option[Seq[Alternative]]) extends Product with Serializable

    

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

    

37. case class RestoreKey(createdAt: Option[String]) extends Product with Serializable

    

38. case class Results(results: Seq[JObject]) extends Product with Serializable

    

39. case class SearchDictionaryResult(hits: Seq[JObject], nbHits: Int, page: Int, nbPages: Int) extends Product with Serializable

    

40. case class SearchFacetResult(facetHits: List[FacetHit], exhaustiveFacetsCount: Option[Boolean], processingTimeMS: Option[Int]) extends Product with Serializable

    

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

    

42. case class SearchRuleResult(hits: Seq[Rule], nbHits: Int) extends SearchHits[Rule] with Product with Serializable

    

43. case class SearchSynonymResult(hits: Seq[AbstractSynonym], nbHits: Int) extends SearchHits[AbstractSynonym] with Product with Serializable

    

44. case class SearchUserID(hits: Seq[UserIDHit], nbHits: Int, page: Int, hitsPerPage: Int, updatedAt: Int) extends Product with Serializable

    

45. case class SetStrategyResponse(status: Int, message: String) extends Product with Serializable

    

46. case class SetStrategyResult(updatedAt: String) extends Product with Serializable

    

47. case class SnippetResult(value: String, matchLevel: String) extends Product with Serializable

    

48. case class SynonymTask(taskID: Long, id: Option[String], updatedAt: Option[String] = None) extends AlgoliaTask with Product with Serializable

    

49. case class Task(taskID: Long, createdAt: Option[String] = None, updatedAt: Option[String] = None) extends AlgoliaTask with Product with Serializable

    

50. case class TaskIndexing(taskID: Long, objectID: String, createdAt: Option[String] = None) extends AlgoliaTask with Product with Serializable

    

51. case class TaskStatus(status: String, pendingTask: Boolean) extends Product with Serializable

    

52. case class TasksMultipleIndex(taskID: Map[String, Long], objectIDs: Seq[String], createdAt: Option[String]) extends AlgoliaTask with Product with Serializable

    

53. case class TasksSingleIndex(taskID: Long, objectIDs: Seq[String], createdAt: Option[String] = None) extends AlgoliaTask with Product with Serializable

    

54. case class TopUserID(topUsers: Map[String, UserData]) extends Product with Serializable

    

55. case class UserData(userID: String, nbRecords: Int, dataSize: Int) extends Product with Serializable

    

56. case class UserDataWithCluster(userID: String, clusterName: String, nbRecords: Int, dataSize: Int) extends Product with Serializable

    

57. case class UserIDHit(userID: String, clusterName: String, nbRecords: Int, dataSize: Int, objectID: String, _highlightResult: Map[String, HighlightResult]) extends Product with Serializable

    

58. case class UserIDList(userIDs: Seq[UserDataWithCluster], page: Int, hitsPerPage: Int) extends Product with Serializable

    

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