commonMain.com.algolia.client.model.analytics.TopHitWithRevenueAnalytics.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-jvm 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.10.1

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

/**
 * TopHitWithRevenueAnalytics
 *
 * @param hit Object ID of a record that's returned as a search result.
 * @param count Number of occurrences.
 * @param clickThroughRate Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
 * @param conversionRate Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
 * @param trackedHitCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
 * @param clickCount Number of clicks associated with this search.
 * @param conversionCount Number of conversions from this search.
 * @param addToCartRate Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
 * @param addToCartCount Number of add-to-cart events from this search.
 * @param purchaseRate Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
 * @param purchaseCount Number of purchase events from this search.
 * @param currencies Revenue associated with this search, broken-down by currencies.
 */
@Serializable
public data class TopHitWithRevenueAnalytics(

  /** Object ID of a record that's returned as a search result. */
  @SerialName(value = "hit") val hit: String,

  /** Number of occurrences. */
  @SerialName(value = "count") val count: Int,

  /** Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.  */
  @SerialName(value = "clickThroughRate") val clickThroughRate: Double,

  /** Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.  */
  @SerialName(value = "conversionRate") val conversionRate: Double,

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

  /** Number of clicks associated with this search. */
  @SerialName(value = "clickCount") val clickCount: Int,

  /** Number of conversions from this search. */
  @SerialName(value = "conversionCount") val conversionCount: Int,

  /** Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.  */
  @SerialName(value = "addToCartRate") val addToCartRate: Double,

  /** Number of add-to-cart events from this search. */
  @SerialName(value = "addToCartCount") val addToCartCount: Int,

  /** Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.  */
  @SerialName(value = "purchaseRate") val purchaseRate: Double,

  /** Number of purchase events from this search. */
  @SerialName(value = "purchaseCount") val purchaseCount: Int,

  /** Revenue associated with this search, broken-down by currencies. */
  @SerialName(value = "currencies") val currencies: Map,
)