commonMain.com.algolia.client.model.analytics.TopSearchWithAnalytics.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of algoliasearch-client-kotlin Show documentation

"Algolia is a powerful search-as-a-service solution, made easy to use with API clients, UI libraries, and pre-built integrations. Algolia API Client for Kotlin lets you easily use the Algolia Search REST API from your JVM project, such as Android or backend implementations."

There is a newer version: 3.13.0

Show newest version

/** Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. */
package com.algolia.client.model.analytics

import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
 * TopSearchWithAnalytics
 *
 * @param search User query.
 * @param count Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn't `true`).
 * @param clickThroughRate [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
 * @param averageClickPosition Average [position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) of clicked search result.
 * @param conversionRate [Conversion rate (CR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
 * @param trackedSearchCount Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
 * @param clickCount Number of click events.
 * @param conversionCount Number of converted clicks.
 * @param nbHits Number of hits the search query matched.
 */
@Serializable
public data class TopSearchWithAnalytics(

  /** User query. */
  @SerialName(value = "search") val search: String,

  /** Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn't `true`). */
  @SerialName(value = "count") val count: Int,

  /** [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).  */
  @SerialName(value = "clickThroughRate") val clickThroughRate: Double,

  /** Average [position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) of clicked search result. */
  @SerialName(value = "averageClickPosition") val averageClickPosition: Int,

  /** [Conversion rate (CR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).  */
  @SerialName(value = "conversionRate") val conversionRate: Double,

  /** Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`. */
  @SerialName(value = "trackedSearchCount") val trackedSearchCount: Int,

  /** Number of click events. */
  @SerialName(value = "clickCount") val clickCount: Int,

  /** Number of converted clicks. */
  @SerialName(value = "conversionCount") val conversionCount: Int,

  /** Number of hits the search query matched. */
  @SerialName(value = "nbHits") val nbHits: Int,
)