Files
sdk/docs/WebsitesApi.md
zeekayandHanzo Dev b55332704a feat: Hanzo Cloud SDK for Kotlin (generated from OpenAPI v8.0.0)
Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and
Android. Generated with openapi-generator kotlin (library=jvm-okhttp4,
useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai.

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-25 07:10:32 -07:00

16 KiB

WebsitesApi

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
analyticsCreateWebsite POST /v1/analytics/websites Create a new website
analyticsDeleteWebsite DELETE /v1/analytics/websites/{websiteId} Delete website
analyticsGetActiveVisitors GET /v1/analytics/websites/{websiteId}/active Get count of active visitors
analyticsGetWebsite GET /v1/analytics/websites/{websiteId} Get website by ID
analyticsGetWebsiteDateRange GET /v1/analytics/websites/{websiteId}/daterange Get the date range of data available for a website
analyticsGetWebsiteValues GET /v1/analytics/websites/{websiteId}/values Get distinct values for a given column type
analyticsListWebsites GET /v1/analytics/websites List websites owned by current user
analyticsResetWebsite POST /v1/analytics/websites/{websiteId}/reset Reset all data for a website
analyticsTransferWebsite POST /v1/analytics/websites/{websiteId}/transfer Transfer website ownership to another user or team
analyticsUpdateWebsite POST /v1/analytics/websites/{websiteId} Update website

analyticsCreateWebsite

AnalyticsWebsite analyticsCreateWebsite(analyticsCreateWebsiteRequest)

Create a new website

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = WebsitesApi()
val analyticsCreateWebsiteRequest : AnalyticsCreateWebsiteRequest =  // AnalyticsCreateWebsiteRequest | 
try {
    val result : AnalyticsWebsite = apiInstance.analyticsCreateWebsite(analyticsCreateWebsiteRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WebsitesApi#analyticsCreateWebsite")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WebsitesApi#analyticsCreateWebsite")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
analyticsCreateWebsiteRequest AnalyticsCreateWebsiteRequest

Return type

AnalyticsWebsite

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

analyticsDeleteWebsite

kotlin.Any analyticsDeleteWebsite(websiteId)

Delete website

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = WebsitesApi()
val websiteId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
try {
    val result : kotlin.Any = apiInstance.analyticsDeleteWebsite(websiteId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WebsitesApi#analyticsDeleteWebsite")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WebsitesApi#analyticsDeleteWebsite")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
websiteId java.util.UUID

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

analyticsGetActiveVisitors

AnalyticsGetActiveVisitors200Response analyticsGetActiveVisitors(websiteId)

Get count of active visitors

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = WebsitesApi()
val websiteId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
try {
    val result : AnalyticsGetActiveVisitors200Response = apiInstance.analyticsGetActiveVisitors(websiteId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WebsitesApi#analyticsGetActiveVisitors")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WebsitesApi#analyticsGetActiveVisitors")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
websiteId java.util.UUID

Return type

AnalyticsGetActiveVisitors200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

analyticsGetWebsite

AnalyticsWebsite analyticsGetWebsite(websiteId)

Get website by ID

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = WebsitesApi()
val websiteId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
try {
    val result : AnalyticsWebsite = apiInstance.analyticsGetWebsite(websiteId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WebsitesApi#analyticsGetWebsite")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WebsitesApi#analyticsGetWebsite")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
websiteId java.util.UUID

Return type

AnalyticsWebsite

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

analyticsGetWebsiteDateRange

AnalyticsGetWebsiteDateRange200Response analyticsGetWebsiteDateRange(websiteId)

Get the date range of data available for a website

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = WebsitesApi()
val websiteId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
try {
    val result : AnalyticsGetWebsiteDateRange200Response = apiInstance.analyticsGetWebsiteDateRange(websiteId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WebsitesApi#analyticsGetWebsiteDateRange")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WebsitesApi#analyticsGetWebsiteDateRange")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
websiteId java.util.UUID

Return type

AnalyticsGetWebsiteDateRange200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

analyticsGetWebsiteValues

kotlin.collections.List<kotlin.String> analyticsGetWebsiteValues(websiteId, startAt, endAt, type, search)

Get distinct values for a given column type

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = WebsitesApi()
val websiteId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val startAt : kotlin.Long = 789 // kotlin.Long | Start timestamp in milliseconds
val endAt : kotlin.Long = 789 // kotlin.Long | End timestamp in milliseconds
val type : kotlin.String = type_example // kotlin.String | Column type (e.g. browser, os, device, country, url, referrer, title, event, tag, language, region, city, host)
val search : kotlin.String = search_example // kotlin.String | 
try {
    val result : kotlin.collections.List<kotlin.String> = apiInstance.analyticsGetWebsiteValues(websiteId, startAt, endAt, type, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WebsitesApi#analyticsGetWebsiteValues")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WebsitesApi#analyticsGetWebsiteValues")
    e.printStackTrace()
}

Parameters

| websiteId | java.util.UUID| | | | startAt | kotlin.Long| Start timestamp in milliseconds | | | endAt | kotlin.Long| End timestamp in milliseconds | | | type | kotlin.String| Column type (e.g. browser, os, device, country, url, referrer, title, event, tag, language, region, city, host) | |

Name Type Description Notes
search kotlin.String [optional]

Return type

kotlin.collections.List<kotlin.String>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

analyticsListWebsites

kotlin.collections.List<AnalyticsWebsite> analyticsListWebsites(page, pageSize, orderBy, search)

List websites owned by current user

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = WebsitesApi()
val page : kotlin.Int = 56 // kotlin.Int | 
val pageSize : kotlin.Int = 56 // kotlin.Int | 
val orderBy : kotlin.String = orderBy_example // kotlin.String | 
val search : kotlin.String = search_example // kotlin.String | 
try {
    val result : kotlin.collections.List<AnalyticsWebsite> = apiInstance.analyticsListWebsites(page, pageSize, orderBy, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WebsitesApi#analyticsListWebsites")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WebsitesApi#analyticsListWebsites")
    e.printStackTrace()
}

Parameters

| page | kotlin.Int| | [optional] | | pageSize | kotlin.Int| | [optional] | | orderBy | kotlin.String| | [optional] |

Name Type Description Notes
search kotlin.String [optional]

Return type

kotlin.collections.List<AnalyticsWebsite>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

analyticsResetWebsite

kotlin.Any analyticsResetWebsite(websiteId)

Reset all data for a website

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = WebsitesApi()
val websiteId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
try {
    val result : kotlin.Any = apiInstance.analyticsResetWebsite(websiteId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WebsitesApi#analyticsResetWebsite")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WebsitesApi#analyticsResetWebsite")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
websiteId java.util.UUID

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

analyticsTransferWebsite

AnalyticsWebsite analyticsTransferWebsite(websiteId, analyticsTransferWebsiteRequest)

Transfer website ownership to another user or team

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = WebsitesApi()
val websiteId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val analyticsTransferWebsiteRequest : AnalyticsTransferWebsiteRequest =  // AnalyticsTransferWebsiteRequest | 
try {
    val result : AnalyticsWebsite = apiInstance.analyticsTransferWebsite(websiteId, analyticsTransferWebsiteRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WebsitesApi#analyticsTransferWebsite")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WebsitesApi#analyticsTransferWebsite")
    e.printStackTrace()
}

Parameters

| websiteId | java.util.UUID| | |

Name Type Description Notes
analyticsTransferWebsiteRequest AnalyticsTransferWebsiteRequest

Return type

AnalyticsWebsite

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

analyticsUpdateWebsite

AnalyticsWebsite analyticsUpdateWebsite(websiteId, analyticsUpdateWebsiteRequest)

Update website

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = WebsitesApi()
val websiteId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val analyticsUpdateWebsiteRequest : AnalyticsUpdateWebsiteRequest =  // AnalyticsUpdateWebsiteRequest | 
try {
    val result : AnalyticsWebsite = apiInstance.analyticsUpdateWebsite(websiteId, analyticsUpdateWebsiteRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WebsitesApi#analyticsUpdateWebsite")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WebsitesApi#analyticsUpdateWebsite")
    e.printStackTrace()
}

Parameters

| websiteId | java.util.UUID| | |

Name Type Description Notes
analyticsUpdateWebsiteRequest AnalyticsUpdateWebsiteRequest

Return type

AnalyticsWebsite

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json