Pre-release. HostCraft is in testing and not yet for sale. These docs describe the current build and may change. Join the waitlist to hear when it launches.

Analytics API

Source: daemon/proto/hostcraft/v1/analytics.proto

AnalyticsService

AnalyticsService reports GoAccess traffic analytics per site. REST: /api/v1/analytics/site/{site_id}/... Every request takes the same period filter: period 24h (default) | 7d | 30d | custom with from/to (RFC 3339). Row messages carry the REST keys verbatim, which are Go field names.

Method	REST route	Permission	Streaming
`GetSiteSummary`	`GET /api/v1/analytics/site/{site_id}/summary`	`AnalyticsRead`	unary
`GetTopPages`	`GET /api/v1/analytics/site/{site_id}/top-pages`	`AnalyticsRead`	unary
`GetTopReferrers`	`GET /api/v1/analytics/site/{site_id}/top-referrers`	`AnalyticsRead`	unary
`GetGeoBreakdown`	`GET /api/v1/analytics/site/{site_id}/geo`	`AnalyticsRead`	unary
`GetBrowserBreakdown`	`GET /api/v1/analytics/site/{site_id}/browsers`	`AnalyticsRead`	unary
`GetStatusCodeBreakdown`	`GET /api/v1/analytics/site/{site_id}/status-codes`	`AnalyticsRead`	unary
`GetTrafficGraph`	`GET /api/v1/analytics/site/{site_id}/traffic-graph`	`AnalyticsRead`	unary

GetSiteSummary

/hostcraft.v1.AnalyticsService/GetSiteSummary

Request: SiteAnalyticsRequest
Response: SiteSummary

GetTopPages

/hostcraft.v1.AnalyticsService/GetTopPages

Request: SiteAnalyticsRequest
Response: TopPagesResponse

GetTopReferrers

/hostcraft.v1.AnalyticsService/GetTopReferrers

Request: SiteAnalyticsRequest
Response: TopReferrersResponse

GetGeoBreakdown

/hostcraft.v1.AnalyticsService/GetGeoBreakdown

Request: SiteAnalyticsRequest
Response: GeoBreakdownResponse

GetBrowserBreakdown

/hostcraft.v1.AnalyticsService/GetBrowserBreakdown

Request: SiteAnalyticsRequest
Response: BrowserBreakdownResponse

GetStatusCodeBreakdown

/hostcraft.v1.AnalyticsService/GetStatusCodeBreakdown

Request: SiteAnalyticsRequest
Response: StatusCodeBreakdownResponse

GetTrafficGraph

/hostcraft.v1.AnalyticsService/GetTrafficGraph

Request: SiteAnalyticsRequest
Response: TrafficGraph

Messages

BrowserBreakdownResponse

Field	Type	Number	Description
`browsers`	`repeated BrowserRow`	1	-

BrowserRow

Field	Type	Number	Description
`Family`	`string`	1	-
`Hits`	`int64`	2	-
`Visitors`	`int64`	3	-

GeoBreakdownResponse

Field	Type	Number	Description
`countries`	`repeated GeoRow`	1	-

GeoRow

Field	Type	Number	Description
`CountryCode`	`string`	1	-
`CountryName`	`string`	2	-
`Hits`	`int64`	3	-
`Visitors`	`int64`	4	-

SiteAnalyticsRequest

Field	Type	Number	Description
`site_id`	`string`	1	-
`account_id`	`string`	2	-
`period`	`string`	3	-
`from`	`string`	4	-
`to`	`string`	5	-
`limit`	`int64`	6	top-pages / top-referrers only

SiteSummary

Field	Type	Number	Description
`account_id`	`string`	1	-
`site_id`	`string`	2	-
`unique_visitors`	`int64`	3	-
`page_views`	`int64`	4	-
`hits`	`int64`	5	-
`bandwidth_bytes`	`int64`	6	-
`not_found`	`int64`	7	-
`failed_requests`	`int64`	8	-
`generated_at`	`google.protobuf.Timestamp`	9	-

StatusCodeBreakdownResponse

Field	Type	Number	Description
`status_codes`	`repeated StatusCodeRow`	1	-

StatusCodeRow

Field	Type	Number	Description
`Code`	`int32`	1	-
`Hits`	`int64`	2	-

TopPage

Field	Type	Number	Description
`Path`	`string`	1	-
`Hits`	`int64`	2	-
`Visitors`	`int64`	3	-
`BandwidthBytes`	`int64`	4	-
`AverageTimeMs`	`double`	5	-

TopPagesResponse

Field	Type	Number	Description
`pages`	`repeated TopPage`	1	-

TopReferrer

Field	Type	Number	Description
`Referrer`	`string`	1	-
`Hits`	`int64`	2	-
`Visitors`	`int64`	3	-

TopReferrersResponse

Field	Type	Number	Description
`referrers`	`repeated TopReferrer`	1	-

TrafficGraph

Field	Type	Number	Description
`account_id`	`string`	1	-
`site_id`	`string`	2	-
`points`	`repeated TrafficPoint`	3	-

TrafficPoint

Field	Type	Number	Description
`At`	`google.protobuf.Timestamp`	1	-
`Visitors`	`int64`	2	-
`PageViews`	`int64`	3	-
`BandwidthBytes`	`int64`	4	-