insights

Documentation

Index

• type Client
  • func NewClient(appID, apiKey string, region algoliaInsights.Region) (*Client, error)
  • func (c *Client) GetEvents(startDate, endDate time.Time, limit int) (*EventsRes, error)
• type Event
• type EventWrapper
• type EventsRes
• type Timestamp
  • func (t *Timestamp) UnmarshalJSON(data []byte) error

Types

type Client

type Client struct {
	*algoliaInsights.APIClient
}

Client wraps the default Insights API client so that we can declare methods on it

func NewClient

func NewClient(appID, apiKey string, region algoliaInsights.Region) (*Client, error)

NewClient instantiates a new Insights API client

func (*Client) GetEvents

func (c *Client) GetEvents(startDate, endDate time.Time, limit int) (*EventsRes, error)

GetEvents retrieves a number of events from the Algolia Insights API.

type Event

type Event struct {
	EventType string    `json:"eventType"`
	EventName string    `json:"eventName"`
	Index     string    `json:"index"`
	UserToken string    `json:"userToken"`
	Timestamp Timestamp `json:"timestamp"`
	ObjectIDs []string  `json:"objectIDs,omitempty"`
	Positions []int     `json:"positions,omitempty"`
	QueryID   string    `json:"queryID,omitempty"`
	Filters   []string  `json:"filters,omitempty"`
}

TODO: Replace this with a type from the API.

type EventWrapper

type EventWrapper struct {
	Event     Event    `json:"event"`
	RequestID string   `json:"requestID"`
	Status    int      `json:"status"`
	Errors    []string `json:"errors"`
	Headers   map[string][]string
}

type EventsRes

type EventsRes struct {
	Events []EventWrapper `json:"events"`
}

type Timestamp

type Timestamp struct {
	time.Time
}

func (*Timestamp) UnmarshalJSON

func (t *Timestamp) UnmarshalJSON(data []byte) error