docs (#45)

* docs

* import call out

Author: matthoare013

examples/import.go

@@ -15,7 +15,9 @@ func ImportExample() error {
 	// fill in your token and project id and service account user name and secret
 	mp := mixpanel.NewClient(
 		"token",
+		// Need to provide project id if you want to use the import api
 		mixpanel.ProjectID(0),
+		// Need to provide service account or api secret if you want to use the import api
 		mixpanel.ServiceAccount("user_name", "secret"),
 	)
 

examples/merge.go

@@ -11,6 +11,8 @@ func Merge() error {
 
 	mp := mixpanel.NewClient(
 		"token",
+		// Need to provide api secret if you want to use the merge api
+		mixpanel.ApiSecret("secret"),
 	)
 
 	// Can use the SetReversedProperty or make the reserved property yourself

identity.go

@@ -18,6 +18,7 @@ type aliasProperties struct {
 	Token      string `json:"token"`
 }
 
+// https://developer.mixpanel.com/reference/identity-create-alias
 func (m *Mixpanel) Alias(ctx context.Context, aliasID, distinctID string) error {
 	payload := &aliasPayload{
 		Event: "$create_alias",
@@ -40,6 +41,8 @@ type mergeProperties struct {
 	DistinctId []string `json:"$distinct_ids"`
 }
 
+// https://developer.mixpanel.com/reference/identity-merge
+// must provide api secret
 func (m *Mixpanel) Merge(ctx context.Context, distinctID1, distinctID2 string) error {
 	payload := &mergePayload{
 		Event: "$merge",

ingestion.go

@@ -126,6 +126,7 @@ func (e ImportGenericError) Error() string {
 
 // Import calls the Import api
 // https://developer.mixpanel.com/reference/import-events
+// Need to provide project id and api secret or service account
 func (m *Mixpanel) Import(ctx context.Context, events []*Event, options ImportOptions) (*ImportSuccess, error) {
 	if len(events) > MaxImportEvents {
 		return nil, fmt.Errorf("max import events is %d", MaxImportEvents)