github.com/launchdarkly/api-client-go@v5.3.0+incompatible/docs/CustomerMetricsApi.md (about) 1 # \CustomerMetricsApi 2 3 All URIs are relative to *https://app.launchdarkly.com/api/v2* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**GetEvaluations**](CustomerMetricsApi.md#GetEvaluations) | **Get** /usage/evaluations/{envId}/{flagKey} | Get events usage by event id and the feature flag key. 8 [**GetEvent**](CustomerMetricsApi.md#GetEvent) | **Get** /usage/events/{type} | Get events usage by event type. 9 [**GetEvents**](CustomerMetricsApi.md#GetEvents) | **Get** /usage/events | Get events usage endpoints. 10 [**GetMAU**](CustomerMetricsApi.md#GetMAU) | **Get** /usage/mau | Get monthly active user data. 11 [**GetMAUByCategory**](CustomerMetricsApi.md#GetMAUByCategory) | **Get** /usage/mau/bycategory | Get monthly active user data by category. 12 [**GetStream**](CustomerMetricsApi.md#GetStream) | **Get** /usage/streams/{source} | Get a stream endpoint and return timeseries data. 13 [**GetStreamBySDK**](CustomerMetricsApi.md#GetStreamBySDK) | **Get** /usage/streams/{source}/bysdkversion | Get a stream timeseries data by source show sdk version metadata. 14 [**GetStreamSDKVersion**](CustomerMetricsApi.md#GetStreamSDKVersion) | **Get** /usage/streams/{source}/sdkversions | Get a stream timeseries data by source and show all sdk version associated. 15 [**GetStreams**](CustomerMetricsApi.md#GetStreams) | **Get** /usage/streams | Returns a list of all streams. 16 [**GetUsage**](CustomerMetricsApi.md#GetUsage) | **Get** /usage | Returns of the usage endpoints available. 17 18 19 # **GetEvaluations** 20 > StreamSdkVersion GetEvaluations(ctx, envId, flagKey) 21 Get events usage by event id and the feature flag key. 22 23 ### Required Parameters 24 25 Name | Type | Description | Notes 26 ------------- | ------------- | ------------- | ------------- 27 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 28 **envId** | **string**| The environment id for the flag evaluations in question. | 29 **flagKey** | **string**| The key of the flag we want metrics for. | 30 31 ### Return type 32 33 [**StreamSdkVersion**](StreamSDKVersion.md) 34 35 ### Authorization 36 37 [Token](../README.md#Token) 38 39 ### HTTP request headers 40 41 - **Content-Type**: application/json 42 - **Accept**: application/json 43 44 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 45 46 # **GetEvent** 47 > StreamSdkVersion GetEvent(ctx, type_) 48 Get events usage by event type. 49 50 ### Required Parameters 51 52 Name | Type | Description | Notes 53 ------------- | ------------- | ------------- | ------------- 54 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 55 **type_** | **string**| The type of event we would like to track. | 56 57 ### Return type 58 59 [**StreamSdkVersion**](StreamSDKVersion.md) 60 61 ### Authorization 62 63 [Token](../README.md#Token) 64 65 ### HTTP request headers 66 67 - **Content-Type**: application/json 68 - **Accept**: application/json 69 70 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 71 72 # **GetEvents** 73 > Events GetEvents(ctx, ) 74 Get events usage endpoints. 75 76 ### Required Parameters 77 This endpoint does not need any parameter. 78 79 ### Return type 80 81 [**Events**](Events.md) 82 83 ### Authorization 84 85 [Token](../README.md#Token) 86 87 ### HTTP request headers 88 89 - **Content-Type**: application/json 90 - **Accept**: application/json 91 92 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 93 94 # **GetMAU** 95 > Mau GetMAU(ctx, ) 96 Get monthly active user data. 97 98 ### Required Parameters 99 This endpoint does not need any parameter. 100 101 ### Return type 102 103 [**Mau**](MAU.md) 104 105 ### Authorization 106 107 [Token](../README.md#Token) 108 109 ### HTTP request headers 110 111 - **Content-Type**: application/json 112 - **Accept**: application/json 113 114 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 115 116 # **GetMAUByCategory** 117 > MaUbyCategory GetMAUByCategory(ctx, ) 118 Get monthly active user data by category. 119 120 ### Required Parameters 121 This endpoint does not need any parameter. 122 123 ### Return type 124 125 [**MaUbyCategory**](MAUbyCategory.md) 126 127 ### Authorization 128 129 [Token](../README.md#Token) 130 131 ### HTTP request headers 132 133 - **Content-Type**: application/json 134 - **Accept**: application/json 135 136 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 137 138 # **GetStream** 139 > Stream GetStream(ctx, source) 140 Get a stream endpoint and return timeseries data. 141 142 ### Required Parameters 143 144 Name | Type | Description | Notes 145 ------------- | ------------- | ------------- | ------------- 146 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 147 **source** | **string**| The source of where the stream comes from. | 148 149 ### Return type 150 151 [**Stream**](Stream.md) 152 153 ### Authorization 154 155 [Token](../README.md#Token) 156 157 ### HTTP request headers 158 159 - **Content-Type**: application/json 160 - **Accept**: application/json 161 162 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 163 164 # **GetStreamBySDK** 165 > StreamBySdk GetStreamBySDK(ctx, source) 166 Get a stream timeseries data by source show sdk version metadata. 167 168 ### Required Parameters 169 170 Name | Type | Description | Notes 171 ------------- | ------------- | ------------- | ------------- 172 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 173 **source** | **string**| The source of where the stream comes from. | 174 175 ### Return type 176 177 [**StreamBySdk**](StreamBySDK.md) 178 179 ### Authorization 180 181 [Token](../README.md#Token) 182 183 ### HTTP request headers 184 185 - **Content-Type**: application/json 186 - **Accept**: application/json 187 188 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 189 190 # **GetStreamSDKVersion** 191 > StreamSdkVersion GetStreamSDKVersion(ctx, source) 192 Get a stream timeseries data by source and show all sdk version associated. 193 194 ### Required Parameters 195 196 Name | Type | Description | Notes 197 ------------- | ------------- | ------------- | ------------- 198 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 199 **source** | **string**| The source of where the stream comes from. | 200 201 ### Return type 202 203 [**StreamSdkVersion**](StreamSDKVersion.md) 204 205 ### Authorization 206 207 [Token](../README.md#Token) 208 209 ### HTTP request headers 210 211 - **Content-Type**: application/json 212 - **Accept**: application/json 213 214 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 215 216 # **GetStreams** 217 > Streams GetStreams(ctx, ) 218 Returns a list of all streams. 219 220 ### Required Parameters 221 This endpoint does not need any parameter. 222 223 ### Return type 224 225 [**Streams**](Streams.md) 226 227 ### Authorization 228 229 [Token](../README.md#Token) 230 231 ### HTTP request headers 232 233 - **Content-Type**: application/json 234 - **Accept**: application/json 235 236 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 237 238 # **GetUsage** 239 > Usage GetUsage(ctx, ) 240 Returns of the usage endpoints available. 241 242 ### Required Parameters 243 This endpoint does not need any parameter. 244 245 ### Return type 246 247 [**Usage**](Usage.md) 248 249 ### Authorization 250 251 [Token](../README.md#Token) 252 253 ### HTTP request headers 254 255 - **Content-Type**: application/json 256 - **Accept**: application/json 257 258 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 259