report.go

package gapi

import (
	"encoding/json"
	"fmt"
	"time"
)

// ReportSchedule represents the schedule from a Grafana report.
type ReportSchedule struct {
	StartDate         *time.Time `json:"startDate,omitempty"`
	EndDate           *time.Time `json:"endDate,omitempty"`
	Frequency         string     `json:"frequency"`
	IntervalFrequency string     `json:"intervalFrequency"`
	IntervalAmount    int64      `json:"intervalAmount"`
	WorkdaysOnly      bool       `json:"workdaysOnly"`
	TimeZone          string     `json:"timeZone"`
	DayOfMonth        string     `json:"dayOfMonth,omitempty"`
}

// ReportOptions represents the options for a Grafana report.
type ReportOptions struct {
	Orientation string `json:"orientation"`
	Layout      string `json:"layout"`
}

// ReportDashboardTimeRange represents the time range from a dashboard on a Grafana report.
type ReportDashboardTimeRange struct {
	From string `json:"from"`
	To   string `json:"to"`
}

// ReportDashboardIdentifier represents the identifier for a dashboard on a Grafana report.
type ReportDashboardIdentifier struct {
	ID   int64  `json:"id,omitempty"`
	UID  string `json:"uid,omitempty"`
	Name string `json:"name,omitempty"`
}

// ReportDashboard represents a dashboard on a Grafana report.
type ReportDashboard struct {
	Dashboard ReportDashboardIdentifier `json:"dashboard"`
	TimeRange ReportDashboardTimeRange  `json:"timeRange"`
	Variables map[string]string         `json:"reportVariables"`
}

// Report represents a Grafana report.
type Report struct {
	// ReadOnly
	ID     int64  `json:"id,omitempty"`
	UserID int64  `json:"userId,omitempty"`
	OrgID  int64  `json:"orgId,omitempty"`
	State  string `json:"state,omitempty"`

	Dashboards []ReportDashboard `json:"dashboards"`

	Name               string         `json:"name"`
	Recipients         string         `json:"recipients"`
	ReplyTo            string         `json:"replyTo"`
	Message            string         `json:"message"`
	Schedule           ReportSchedule `json:"schedule"`
	Options            ReportOptions  `json:"options"`
	EnableDashboardURL bool           `json:"enableDashboardUrl"`
	EnableCSV          bool           `json:"enableCsv"`
	Formats            []string       `json:"formats"`
	ScaleFactor        int64          `json:"scaleFactor"`
}

// Report fetches and returns a Grafana report.
func (c *Client) Report(id int64) (*Report, error) {
	path := fmt.Sprintf("/api/reports/%d", id)
	report := &Report{}
	err := c.request("GET", path, nil, nil, report)
	if err != nil {
		return nil, err
	}

	return report, nil
}

// NewReport creates a new Grafana report.
func (c *Client) NewReport(report Report) (int64, error) {
	data, err := json.Marshal(report)
	if err != nil {
		return 0, err
	}

	result := struct {
		ID int64
	}{}

	err = c.request("POST", "/api/reports", nil, data, &result)
	if err != nil {
		return 0, err
	}

	return result.ID, nil
}

// UpdateReport updates a Grafana report.
func (c *Client) UpdateReport(report Report) error {
	path := fmt.Sprintf("/api/reports/%d", report.ID)
	data, err := json.Marshal(report)
	if err != nil {
		return err
	}

	return c.request("PUT", path, nil, data, nil)
}

// DeleteReport deletes the Grafana report whose ID it's passed.
func (c *Client) DeleteReport(id int64) error {
	path := fmt.Sprintf("/api/reports/%d", id)

	return c.request("DELETE", path, nil, nil, nil)
}