Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ajbosco/segment-config-go
A Go client library for the Segment Config API
https://github.com/ajbosco/segment-config-go
go golang segment segmentio
Last synced: 22 days ago
JSON representation
A Go client library for the Segment Config API
- Host: GitHub
- URL: https://github.com/ajbosco/segment-config-go
- Owner: ajbosco
- License: mit
- Created: 2018-12-09T20:31:07.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-07-27T14:45:10.000Z (over 2 years ago)
- Last Synced: 2024-06-19T23:13:05.918Z (5 months ago)
- Topics: go, golang, segment, segmentio
- Language: Go
- Size: 219 KB
- Stars: 2
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# segment-config-go
[](https://github.com/ajbosco/segment-config-go/actions?workflow=build)
[](https://goreportcard.com/report/github.com/ajbosco/segment-config-go)
[](https://godoc.org/github.com/ajbosco/segment-config-go/segment)
segment-config-go is a Go client library for accessing the [Segment Config](https://segment.com/docs/config-api/) API.
This library allows you to do the following programmatically:
* List all your Segment sources and destinations
* Create [sources](https://segment.com/docs/sources/)
* Create or modify [destinations](https://segment.com/docs/destinations/)
* Enable and disable destinations
* Create, list or modify [tracking plans](https://segment.com/docs/protocols/tracking-plan/create/)
## Authentication
segment-config-go requires a Segment Personal Access Token for authentication. You can generate one with the appropriate access by following the steps in the Segment [documentation](https://segment.com/docs/config-api/authentication/)
## Usage
```go
import "github.com/ajbosco/segment-config-go/segment"
```
Construct a new Segment client with your access token and Segment workspace. For example:
```go
accessToken := os.Getenv("ACCESS_TOKEN")
segmentWorkspace := os.Getenv("SEGMENT_WORKSPACE")
client := segment.NewClient(accessToken, segmentWorkspace)
```
Now you can interact with the API to do things like list all [sources](https://segment.com/docs/sources/) in your workspace:
```go
sources, err := c.ListSources()
```
List [destinations](https://segment.com/docs/destinations/) for a given source:
```go
destinations, err := c.ListDestinations("your-source")
```
Create a new [source](https://segment.com/docs/sources/):
```go
source, err := c.CreateSource("your-source", "catalog/sources/javascript")
```
Create a new [destination](https://segment.com/docs/destinations/):
```go
source, err := c.CreateDestination("your-source", "google-analytics", "cloud", false, nil)
```
Create a new [tracking plan](https://segment.com/docs/protocols/tracking-plan/create/):
```go
tp := TrackingPlan{
DisplayName: "Your Tracking Plan",
Rules: RuleSet{
Global: Rules{
Schema: "http://json-schema.org/draft-04/schema#",
Type: "object",
Properties: RuleProperties{
Context: Properties{
Type: "object",
Properties: map[string]Property{},
},
Properties: Properties{},
Traits: Properties{},
},
},
Events: []Event{
{
Name: "Test Event",
Description: "A simple test event",
Rules: Rules{
Schema: "http://json-schema.org/draft-07/schema#",
Type: "object",
Properties: RuleProperties{
Traits: Properties{},
Properties: Properties{
Required: []string{"user_id"},
Type: "object",
Properties: map[string]Property{
"user_id": {
Description: "unique id of the user",
Type: []string{"string"},
},
},
},
},
},
},
},
},
}
trackingPlan, err := c.CreateTrackingPlan(tp)
```
Get an existing [tracking plan](https://segment.com/docs/protocols/tracking-plan/create/):
```go
trackingPlan, err := c.GetTrackingPlan("rs_123abc")
```
List all [tracking plans](https://segment.com/docs/protocols/tracking-plan/create/):
```go
trackingPlans, err := c.ListTrackingPlans()
```
Update an existing [tracking plan](https://segment.com/docs/protocols/tracking-plan/create/):
```go
tp := TrackingPlan{
DisplayName: "Your Tracking Plan",
Rules: RuleSet{
Global: Rules{
Schema: "http://json-schema.org/draft-04/schema#",
Type: "object",
Properties: RuleProperties{
Context: Properties{
Type: "object",
Properties: map[string]Property{},
},
Properties: Properties{},
Traits: Properties{},
},
},
Events: []Event{
{
Name: "Test Event",
Description: "A simple test event",
Rules: Rules{
Schema: "http://json-schema.org/draft-07/schema#",
Type: "object",
Properties: RuleProperties{
Traits: Properties{},
Properties: Properties{
Required: []string{"user_id"},
Type: "object",
Properties: map[string]Property{
"user_id": {
Description: "unique id of the user",
Type: []string{"string"},
},
},
},
},
},
},
},
},
}
trackingPlan, err := c.UpdateTrackingPlan("rs_123abc", tp)
```
Delete an existing [tracking plan](https://segment.com/docs/protocols/tracking-plan/create/):
```go
err := client.DeleteTrackingPlan("rs_123abc")
```