Add comment on VirtualDNSUserAnalyticsOptions struct and VirtualDNSUs…

…erAnalytics method
cloudflare · Nov 14, 2018 · c4e288c · c4e288c
1 parent 782398a
commit c4e288c
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/virtualdns.go b/virtualdns.go
@@ -40,6 +40,7 @@ type VirtualDNSAnalytics struct {
 	Max    VirtualDNSAnalyticsMetrics `json:"max"`
 }
 
+// VirtualDNSUserAnalyticsOptions represents range and dimension selection on analytics endpoint
 type VirtualDNSUserAnalyticsOptions struct {
 	Metrics []string
 	Since   *time.Time
@@ -173,6 +174,7 @@ func (o VirtualDNSUserAnalyticsOptions) encode() string {
 	return v.Encode()
 }
 
+// VirtualDNSUserAnalytics retrieves analytics report for a specified dimension and time range
 func (api *API) VirtualDNSUserAnalytics(virtualDNSID string, o VirtualDNSUserAnalyticsOptions) (VirtualDNSAnalytics, error) {
 	uri := "/user/virtual_dns/" + virtualDNSID + "/dns_analytics/report?" + o.encode()
 	res, err := api.makeRequest("GET", uri, nil)