All URIs are relative to https://api.notefile.net
| Method | HTTP request | Description |
|---|---|---|
| GetDataUsage | Get /v1/projects/{projectOrProductUID}/usage/data | |
| GetEventsUsage | Get /v1/projects/{projectOrProductUID}/usage/events | |
| GetRouteLogsUsage | Get /v1/projects/{projectOrProductUID}/usage/route-logs | |
| GetSessionsUsage | Get /v1/projects/{projectOrProductUID}/usage/sessions |
GetDataUsage200Response GetDataUsage(ctx, projectOrProductUID).Period(period).StartDate(startDate).EndDate(endDate).DeviceUID(deviceUID).FleetUID(fleetUID).Limit(limit).Aggregate(aggregate).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/blues/notehub-go"
)
func main() {
projectOrProductUID := "app:2606f411-dea6-44a0-9743-1130f57d77d8" // string |
period := "period_example" // string | Period type for aggregation
startDate := int32(1628631763) // int32 | Start date for filtering results, specified as a Unix timestamp (optional)
endDate := int32(1657894210) // int32 | End date for filtering results, specified as a Unix timestamp (optional)
deviceUID := []string{"Inner_example"} // []string | A Device UID. (optional)
fleetUID := []string{"Inner_example"} // []string | Filter by Fleet UID (optional)
limit := int32(56) // int32 | Limit the number of data points returned (optional) (default to 200000)
aggregate := "aggregate_example" // string | Aggregation level for results (optional) (default to "device")
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UsageAPI.GetDataUsage(context.Background(), projectOrProductUID).Period(period).StartDate(startDate).EndDate(endDate).DeviceUID(deviceUID).FleetUID(fleetUID).Limit(limit).Aggregate(aggregate).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UsageAPI.GetDataUsage``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetDataUsage`: GetDataUsage200Response
fmt.Fprintf(os.Stdout, "Response from `UsageAPI.GetDataUsage`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectOrProductUID | string |
Other parameters are passed through a pointer to a apiGetDataUsageRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
period | string | Period type for aggregation | startDate | int32 | Start date for filtering results, specified as a Unix timestamp | endDate | int32 | End date for filtering results, specified as a Unix timestamp | deviceUID | []string | A Device UID. | fleetUID | []string | Filter by Fleet UID | limit | int32 | Limit the number of data points returned | [default to 200000] aggregate | string | Aggregation level for results | [default to "device"]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UsageEventsResponse GetEventsUsage(ctx, projectOrProductUID).Period(period).StartDate(startDate).EndDate(endDate).DeviceUID(deviceUID).FleetUID(fleetUID).Limit(limit).Aggregate(aggregate).Notefile(notefile).SkipRecentData(skipRecentData).IncludeNotefiles(includeNotefiles).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/blues/notehub-go"
)
func main() {
projectOrProductUID := "app:2606f411-dea6-44a0-9743-1130f57d77d8" // string |
period := "period_example" // string | Period type for aggregation
startDate := int32(1628631763) // int32 | Start date for filtering results, specified as a Unix timestamp (optional)
endDate := int32(1657894210) // int32 | End date for filtering results, specified as a Unix timestamp (optional)
deviceUID := []string{"Inner_example"} // []string | A Device UID. (optional)
fleetUID := []string{"Inner_example"} // []string | Filter by Fleet UID (optional)
limit := int32(56) // int32 | Limit the number of data points returned (optional) (default to 200000)
aggregate := "aggregate_example" // string | Aggregation level for results (optional) (default to "device")
notefile := []string{"Inner_example"} // []string | Filter to specific notefiles (optional)
skipRecentData := true // bool | When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (optional) (default to false)
includeNotefiles := true // bool | Include per-notefile event counts in the response (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UsageAPI.GetEventsUsage(context.Background(), projectOrProductUID).Period(period).StartDate(startDate).EndDate(endDate).DeviceUID(deviceUID).FleetUID(fleetUID).Limit(limit).Aggregate(aggregate).Notefile(notefile).SkipRecentData(skipRecentData).IncludeNotefiles(includeNotefiles).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UsageAPI.GetEventsUsage``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetEventsUsage`: UsageEventsResponse
fmt.Fprintf(os.Stdout, "Response from `UsageAPI.GetEventsUsage`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectOrProductUID | string |
Other parameters are passed through a pointer to a apiGetEventsUsageRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
period | string | Period type for aggregation | startDate | int32 | Start date for filtering results, specified as a Unix timestamp | endDate | int32 | End date for filtering results, specified as a Unix timestamp | deviceUID | []string | A Device UID. | fleetUID | []string | Filter by Fleet UID | limit | int32 | Limit the number of data points returned | [default to 200000] aggregate | string | Aggregation level for results | [default to "device"] notefile | []string | Filter to specific notefiles | skipRecentData | bool | When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. | [default to false] includeNotefiles | bool | Include per-notefile event counts in the response | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetRouteLogsUsage200Response GetRouteLogsUsage(ctx, projectOrProductUID).Period(period).StartDate(startDate).EndDate(endDate).RouteUID(routeUID).Limit(limit).Aggregate(aggregate).SkipRecentData(skipRecentData).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/blues/notehub-go"
)
func main() {
projectOrProductUID := "app:2606f411-dea6-44a0-9743-1130f57d77d8" // string |
period := "period_example" // string | Period type for aggregation
startDate := int32(1628631763) // int32 | Start date for filtering results, specified as a Unix timestamp (optional)
endDate := int32(1657894210) // int32 | End date for filtering results, specified as a Unix timestamp (optional)
routeUID := []string{"Inner_example"} // []string | A Route UID. (optional)
limit := int32(56) // int32 | Limit the number of data points returned (optional) (default to 200000)
aggregate := "aggregate_example" // string | Aggregation level for results (optional) (default to "route")
skipRecentData := true // bool | When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UsageAPI.GetRouteLogsUsage(context.Background(), projectOrProductUID).Period(period).StartDate(startDate).EndDate(endDate).RouteUID(routeUID).Limit(limit).Aggregate(aggregate).SkipRecentData(skipRecentData).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UsageAPI.GetRouteLogsUsage``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetRouteLogsUsage`: GetRouteLogsUsage200Response
fmt.Fprintf(os.Stdout, "Response from `UsageAPI.GetRouteLogsUsage`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectOrProductUID | string |
Other parameters are passed through a pointer to a apiGetRouteLogsUsageRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
period | string | Period type for aggregation | startDate | int32 | Start date for filtering results, specified as a Unix timestamp | endDate | int32 | End date for filtering results, specified as a Unix timestamp | routeUID | []string | A Route UID. | limit | int32 | Limit the number of data points returned | [default to 200000] aggregate | string | Aggregation level for results | [default to "route"] skipRecentData | bool | When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetSessionsUsage200Response GetSessionsUsage(ctx, projectOrProductUID).Period(period).StartDate(startDate).EndDate(endDate).DeviceUID(deviceUID).FleetUID(fleetUID).Limit(limit).Aggregate(aggregate).SkipRecentData(skipRecentData).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/blues/notehub-go"
)
func main() {
projectOrProductUID := "app:2606f411-dea6-44a0-9743-1130f57d77d8" // string |
period := "period_example" // string | Period type for aggregation
startDate := int32(1628631763) // int32 | Start date for filtering results, specified as a Unix timestamp (optional)
endDate := int32(1657894210) // int32 | End date for filtering results, specified as a Unix timestamp (optional)
deviceUID := []string{"Inner_example"} // []string | A Device UID. (optional)
fleetUID := []string{"Inner_example"} // []string | Filter by Fleet UID (optional)
limit := int32(56) // int32 | Limit the number of data points returned (optional) (default to 200000)
aggregate := "aggregate_example" // string | Aggregation level for results (optional) (default to "device")
skipRecentData := true // bool | When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UsageAPI.GetSessionsUsage(context.Background(), projectOrProductUID).Period(period).StartDate(startDate).EndDate(endDate).DeviceUID(deviceUID).FleetUID(fleetUID).Limit(limit).Aggregate(aggregate).SkipRecentData(skipRecentData).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UsageAPI.GetSessionsUsage``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetSessionsUsage`: GetSessionsUsage200Response
fmt.Fprintf(os.Stdout, "Response from `UsageAPI.GetSessionsUsage`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectOrProductUID | string |
Other parameters are passed through a pointer to a apiGetSessionsUsageRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
period | string | Period type for aggregation | startDate | int32 | Start date for filtering results, specified as a Unix timestamp | endDate | int32 | End date for filtering results, specified as a Unix timestamp | deviceUID | []string | A Device UID. | fleetUID | []string | Filter by Fleet UID | limit | int32 | Limit the number of data points returned | [default to 200000] aggregate | string | Aggregation level for results | [default to "device"] skipRecentData | bool | When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]