Files
sdk/docs/ReportsApi.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

24 KiB

ReportsApi

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

Method HTTP request Description
analyticsCreateReport POST /v1/analytics/reports Create a new report
analyticsDeleteReport DELETE /v1/analytics/reports/{reportId} Delete a report
analyticsGetReport GET /v1/analytics/reports/{reportId} Get a report by ID
analyticsGetRevenueValues GET /v1/analytics/reports/revenue Get available revenue values for a website
analyticsGetWebsiteReports GET /v1/analytics/websites/{websiteId}/reports List reports for a specific website
analyticsListReports GET /v1/analytics/reports List reports, optionally filtered by website or team
analyticsRunAttributionReport POST /v1/analytics/reports/attribution Run an attribution report
analyticsRunFunnelReport POST /v1/analytics/reports/funnel Run a funnel report
analyticsRunGoalsReport POST /v1/analytics/reports/goals Run a goals report
analyticsRunInsightsReport POST /v1/analytics/reports/insights Run an insights report
analyticsRunJourneyReport POST /v1/analytics/reports/journey Run a user journey report
analyticsRunRetentionReport POST /v1/analytics/reports/retention Run a retention report
analyticsRunRevenueReport POST /v1/analytics/reports/revenue Run a revenue report
analyticsRunUtmReport POST /v1/analytics/reports/utm Run a UTM report
analyticsUpdateReport POST /v1/analytics/reports/{reportId} Update a report

analyticsCreateReport

AnalyticsReport analyticsCreateReport(analyticsCreateReportRequest)

Create a new report

Example

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

val apiInstance = ReportsApi()
val analyticsCreateReportRequest : AnalyticsCreateReportRequest =  // AnalyticsCreateReportRequest | 
try {
    val result : AnalyticsReport = apiInstance.analyticsCreateReport(analyticsCreateReportRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#analyticsCreateReport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#analyticsCreateReport")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
analyticsCreateReportRequest AnalyticsCreateReportRequest

Return type

AnalyticsReport

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsDeleteReport

kotlin.Any analyticsDeleteReport(reportId)

Delete a report

Example

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

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

Parameters

Name Type Description Notes
reportId 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

analyticsGetReport

AnalyticsReport analyticsGetReport(reportId)

Get a report by ID

Example

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

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

Parameters

Name Type Description Notes
reportId java.util.UUID

Return type

AnalyticsReport

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsGetRevenueValues

kotlin.collections.List<kotlin.Any> analyticsGetRevenueValues(websiteId, startDate, endDate)

Get available revenue values for a website

Example

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

val apiInstance = ReportsApi()
val websiteId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val startDate : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | 
val endDate : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | 
try {
    val result : kotlin.collections.List<kotlin.Any> = apiInstance.analyticsGetRevenueValues(websiteId, startDate, endDate)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#analyticsGetRevenueValues")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#analyticsGetRevenueValues")
    e.printStackTrace()
}

Parameters

| websiteId | java.util.UUID| | | | startDate | java.time.OffsetDateTime| | |

Name Type Description Notes
endDate java.time.OffsetDateTime

Return type

kotlin.collections.List<kotlin.Any>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsGetWebsiteReports

kotlin.collections.List<AnalyticsReport> analyticsGetWebsiteReports(websiteId, page, pageSize, orderBy, search)

List reports for a specific website

Example

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

val apiInstance = ReportsApi()
val websiteId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
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<AnalyticsReport> = apiInstance.analyticsGetWebsiteReports(websiteId, page, pageSize, orderBy, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#analyticsGetWebsiteReports")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#analyticsGetWebsiteReports")
    e.printStackTrace()
}

Parameters

| websiteId | java.util.UUID| | | | 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<AnalyticsReport>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsListReports

kotlin.collections.List<AnalyticsReport> analyticsListReports(websiteId, teamId, page, pageSize, orderBy, search)

List reports, optionally filtered by website or team

Example

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

val apiInstance = ReportsApi()
val websiteId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val teamId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
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<AnalyticsReport> = apiInstance.analyticsListReports(websiteId, teamId, page, pageSize, orderBy, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#analyticsListReports")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#analyticsListReports")
    e.printStackTrace()
}

Parameters

| websiteId | java.util.UUID| | [optional] | | teamId | java.util.UUID| | [optional] | | 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<AnalyticsReport>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsRunAttributionReport

kotlin.collections.List<kotlin.Any> analyticsRunAttributionReport(analyticsRunAttributionReportRequest)

Run an attribution report

Example

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

val apiInstance = ReportsApi()
val analyticsRunAttributionReportRequest : AnalyticsRunAttributionReportRequest =  // AnalyticsRunAttributionReportRequest | 
try {
    val result : kotlin.collections.List<kotlin.Any> = apiInstance.analyticsRunAttributionReport(analyticsRunAttributionReportRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#analyticsRunAttributionReport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#analyticsRunAttributionReport")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
analyticsRunAttributionReportRequest AnalyticsRunAttributionReportRequest

Return type

kotlin.collections.List<kotlin.Any>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsRunFunnelReport

kotlin.collections.List<kotlin.Any> analyticsRunFunnelReport(analyticsRunFunnelReportRequest)

Run a funnel report

Example

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

val apiInstance = ReportsApi()
val analyticsRunFunnelReportRequest : AnalyticsRunFunnelReportRequest =  // AnalyticsRunFunnelReportRequest | 
try {
    val result : kotlin.collections.List<kotlin.Any> = apiInstance.analyticsRunFunnelReport(analyticsRunFunnelReportRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#analyticsRunFunnelReport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#analyticsRunFunnelReport")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
analyticsRunFunnelReportRequest AnalyticsRunFunnelReportRequest

Return type

kotlin.collections.List<kotlin.Any>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsRunGoalsReport

kotlin.collections.List<kotlin.Any> analyticsRunGoalsReport(analyticsRunGoalsReportRequest)

Run a goals report

Example

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

val apiInstance = ReportsApi()
val analyticsRunGoalsReportRequest : AnalyticsRunGoalsReportRequest =  // AnalyticsRunGoalsReportRequest | 
try {
    val result : kotlin.collections.List<kotlin.Any> = apiInstance.analyticsRunGoalsReport(analyticsRunGoalsReportRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#analyticsRunGoalsReport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#analyticsRunGoalsReport")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
analyticsRunGoalsReportRequest AnalyticsRunGoalsReportRequest

Return type

kotlin.collections.List<kotlin.Any>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsRunInsightsReport

kotlin.collections.List<kotlin.Any> analyticsRunInsightsReport(analyticsRunInsightsReportRequest)

Run an insights report

Example

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

val apiInstance = ReportsApi()
val analyticsRunInsightsReportRequest : AnalyticsRunInsightsReportRequest =  // AnalyticsRunInsightsReportRequest | 
try {
    val result : kotlin.collections.List<kotlin.Any> = apiInstance.analyticsRunInsightsReport(analyticsRunInsightsReportRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#analyticsRunInsightsReport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#analyticsRunInsightsReport")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
analyticsRunInsightsReportRequest AnalyticsRunInsightsReportRequest

Return type

kotlin.collections.List<kotlin.Any>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsRunJourneyReport

kotlin.collections.List<kotlin.Any> analyticsRunJourneyReport(analyticsRunJourneyReportRequest)

Run a user journey report

Example

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

val apiInstance = ReportsApi()
val analyticsRunJourneyReportRequest : AnalyticsRunJourneyReportRequest =  // AnalyticsRunJourneyReportRequest | 
try {
    val result : kotlin.collections.List<kotlin.Any> = apiInstance.analyticsRunJourneyReport(analyticsRunJourneyReportRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#analyticsRunJourneyReport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#analyticsRunJourneyReport")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
analyticsRunJourneyReportRequest AnalyticsRunJourneyReportRequest

Return type

kotlin.collections.List<kotlin.Any>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsRunRetentionReport

kotlin.collections.List<kotlin.Any> analyticsRunRetentionReport(analyticsRunRetentionReportRequest)

Run a retention report

Example

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

val apiInstance = ReportsApi()
val analyticsRunRetentionReportRequest : AnalyticsRunRetentionReportRequest =  // AnalyticsRunRetentionReportRequest | 
try {
    val result : kotlin.collections.List<kotlin.Any> = apiInstance.analyticsRunRetentionReport(analyticsRunRetentionReportRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#analyticsRunRetentionReport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#analyticsRunRetentionReport")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
analyticsRunRetentionReportRequest AnalyticsRunRetentionReportRequest

Return type

kotlin.collections.List<kotlin.Any>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsRunRevenueReport

kotlin.collections.List<kotlin.Any> analyticsRunRevenueReport(analyticsRunRevenueReportRequest)

Run a revenue report

Example

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

val apiInstance = ReportsApi()
val analyticsRunRevenueReportRequest : AnalyticsRunRevenueReportRequest =  // AnalyticsRunRevenueReportRequest | 
try {
    val result : kotlin.collections.List<kotlin.Any> = apiInstance.analyticsRunRevenueReport(analyticsRunRevenueReportRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#analyticsRunRevenueReport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#analyticsRunRevenueReport")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
analyticsRunRevenueReportRequest AnalyticsRunRevenueReportRequest

Return type

kotlin.collections.List<kotlin.Any>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsRunUtmReport

kotlin.collections.List<kotlin.Any> analyticsRunUtmReport(analyticsRunUtmReportRequest)

Run a UTM report

Example

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

val apiInstance = ReportsApi()
val analyticsRunUtmReportRequest : AnalyticsRunUtmReportRequest =  // AnalyticsRunUtmReportRequest | 
try {
    val result : kotlin.collections.List<kotlin.Any> = apiInstance.analyticsRunUtmReport(analyticsRunUtmReportRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#analyticsRunUtmReport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#analyticsRunUtmReport")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
analyticsRunUtmReportRequest AnalyticsRunUtmReportRequest

Return type

kotlin.collections.List<kotlin.Any>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsUpdateReport

AnalyticsReport analyticsUpdateReport(reportId, analyticsCreateReportRequest)

Update a report

Example

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

val apiInstance = ReportsApi()
val reportId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val analyticsCreateReportRequest : AnalyticsCreateReportRequest =  // AnalyticsCreateReportRequest | 
try {
    val result : AnalyticsReport = apiInstance.analyticsUpdateReport(reportId, analyticsCreateReportRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#analyticsUpdateReport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#analyticsUpdateReport")
    e.printStackTrace()
}

Parameters

| reportId | java.util.UUID| | |

Name Type Description Notes
analyticsCreateReportRequest AnalyticsCreateReportRequest

Return type

AnalyticsReport

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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