All URIs are relative to https://app.launchdarkly.com
| Method | HTTP request | Description |
|---|---|---|
| CreateMetricGroup | Post /api/v2/projects/{projectKey}/metric-groups | Create metric group |
| DeleteMetricGroup | Delete /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} | Delete metric group |
| GetMetricGroup | Get /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} | Get metric group |
| GetMetricGroups | Get /api/v2/projects/{projectKey}/metric-groups | List metric groups |
| PatchMetricGroup | Patch /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} | Patch metric group |
MetricGroupRep CreateMetricGroup(ctx, projectKey).MetricGroupPost(metricGroupPost).Execute()
Create metric group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/launchdarkly/api-client-go"
)
func main() {
projectKey := "projectKey_example" // string | The project key
metricGroupPost := *openapiclient.NewMetricGroupPost("My metric group", "funnel", "569fdeadbeef1644facecafe", []string{"Tags_example"}, []openapiclient.MetricInMetricGroupInput{*openapiclient.NewMetricInMetricGroupInput("metric-key-123abc", "Step 1")}) // MetricGroupPost |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MetricsBetaApi.CreateMetricGroup(context.Background(), projectKey).MetricGroupPost(metricGroupPost).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MetricsBetaApi.CreateMetricGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateMetricGroup`: MetricGroupRep
fmt.Fprintf(os.Stdout, "Response from `MetricsBetaApi.CreateMetricGroup`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectKey | string | The project key |
Other parameters are passed through a pointer to a apiCreateMetricGroupRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
metricGroupPost | MetricGroupPost | |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteMetricGroup(ctx, projectKey, metricGroupKey).Execute()
Delete metric group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/launchdarkly/api-client-go"
)
func main() {
projectKey := "projectKey_example" // string | The project key
metricGroupKey := "metricGroupKey_example" // string | The metric group key
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.MetricsBetaApi.DeleteMetricGroup(context.Background(), projectKey, metricGroupKey).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MetricsBetaApi.DeleteMetricGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectKey | string | The project key | |
| metricGroupKey | string | The metric group key |
Other parameters are passed through a pointer to a apiDeleteMetricGroupRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MetricGroupRep GetMetricGroup(ctx, projectKey, metricGroupKey).Expand(expand).Execute()
Get metric group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/launchdarkly/api-client-go"
)
func main() {
projectKey := "projectKey_example" // string | The project key
metricGroupKey := "metricGroupKey_example" // string | The metric group key
expand := "expand_example" // string | A comma-separated list of properties that can reveal additional information in the response. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MetricsBetaApi.GetMetricGroup(context.Background(), projectKey, metricGroupKey).Expand(expand).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MetricsBetaApi.GetMetricGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetMetricGroup`: MetricGroupRep
fmt.Fprintf(os.Stdout, "Response from `MetricsBetaApi.GetMetricGroup`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectKey | string | The project key | |
| metricGroupKey | string | The metric group key |
Other parameters are passed through a pointer to a apiGetMetricGroupRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
expand | string | A comma-separated list of properties that can reveal additional information in the response. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MetricGroupCollectionRep GetMetricGroups(ctx, projectKey).Filter(filter).Sort(sort).Expand(expand).Limit(limit).Offset(offset).Execute()
List metric groups
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/launchdarkly/api-client-go"
)
func main() {
projectKey := "projectKey_example" // string | The project key
filter := "filter_example" // string | Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. (optional)
sort := "sort_example" // string | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. (optional)
expand := "expand_example" // string | This parameter is reserved for future use and is not currently supported on this endpoint. (optional)
limit := int64(789) // int64 | The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. (optional)
offset := int64(789) // int64 | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MetricsBetaApi.GetMetricGroups(context.Background(), projectKey).Filter(filter).Sort(sort).Expand(expand).Limit(limit).Offset(offset).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MetricsBetaApi.GetMetricGroups``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetMetricGroups`: MetricGroupCollectionRep
fmt.Fprintf(os.Stdout, "Response from `MetricsBetaApi.GetMetricGroups`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectKey | string | The project key |
Other parameters are passed through a pointer to a apiGetMetricGroupsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
filter | string | Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. | sort | string | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. | expand | string | This parameter is reserved for future use and is not currently supported on this endpoint. | limit | int64 | The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. | offset | int64 | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MetricGroupRep PatchMetricGroup(ctx, projectKey, metricGroupKey).PatchOperation(patchOperation).Execute()
Patch metric group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/launchdarkly/api-client-go"
)
func main() {
projectKey := "projectKey_example" // string | The project key
metricGroupKey := "metricGroupKey_example" // string | The metric group key
patchOperation := []openapiclient.PatchOperation{*openapiclient.NewPatchOperation("replace", "/exampleField")} // []PatchOperation |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MetricsBetaApi.PatchMetricGroup(context.Background(), projectKey, metricGroupKey).PatchOperation(patchOperation).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MetricsBetaApi.PatchMetricGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PatchMetricGroup`: MetricGroupRep
fmt.Fprintf(os.Stdout, "Response from `MetricsBetaApi.PatchMetricGroup`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectKey | string | The project key | |
| metricGroupKey | string | The metric group key |
Other parameters are passed through a pointer to a apiPatchMetricGroupRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
patchOperation | []PatchOperation | |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]