Skip to content

Latest commit

 

History

History
152 lines (102 loc) · 5.12 KB

UsagesApi.md

File metadata and controls

152 lines (102 loc) · 5.12 KB
Raw

\UsagesApi

All URIs are relative to https://app.koyeb.com

Method HTTP request Description
GetOrganizationUsage Get /v1/usages Get organization usage
GetOrganizationUsageDetails Get /v1/usages/details Get organization usage details

GetOrganizationUsage

GetOrganizationUsageReply GetOrganizationUsage(ctx).StartingTime(startingTime).EndingTime(endingTime).Execute()

Get organization usage

Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    startingTime := time.Now() // time.Time | The starting time of the period to get data from (optional)
    endingTime := time.Now() // time.Time | The ending time of the period to get data from (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UsagesApi.GetOrganizationUsage(context.Background()).StartingTime(startingTime).EndingTime(endingTime).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsagesApi.GetOrganizationUsage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetOrganizationUsage`: GetOrganizationUsageReply
    fmt.Fprintf(os.Stdout, "Response from `UsagesApi.GetOrganizationUsage`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetOrganizationUsageRequest struct via the builder pattern

Name Type Description Notes
startingTime time.Time The starting time of the period to get data from
endingTime time.Time The ending time of the period to get data from

Return type

GetOrganizationUsageReply

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOrganizationUsageDetails

GetOrganizationUsageDetailsReply GetOrganizationUsageDetails(ctx).StartingTime(startingTime).EndingTime(endingTime).Limit(limit).Offset(offset).Order(order).Accept(accept).Execute()

Get organization usage details

Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    startingTime := time.Now() // time.Time | The starting time of the period to get data from (optional)
    endingTime := time.Now() // time.Time | The ending time of the period to get data from (optional)
    limit := "limit_example" // string | (Optional) The number of items to return (optional)
    offset := "offset_example" // string | (Optional) The offset in the list of item to return (optional)
    order := "order_example" // string | (Optional) Sorts the list in the ascending or the descending order (optional)
    accept := "accept_example" // string | If defined with the value 'text/csv', a csv file is returned (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UsagesApi.GetOrganizationUsageDetails(context.Background()).StartingTime(startingTime).EndingTime(endingTime).Limit(limit).Offset(offset).Order(order).Accept(accept).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsagesApi.GetOrganizationUsageDetails``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetOrganizationUsageDetails`: GetOrganizationUsageDetailsReply
    fmt.Fprintf(os.Stdout, "Response from `UsagesApi.GetOrganizationUsageDetails`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetOrganizationUsageDetailsRequest struct via the builder pattern

Name Type Description Notes
startingTime time.Time The starting time of the period to get data from
endingTime time.Time The ending time of the period to get data from
limit string (Optional) The number of items to return
offset string (Optional) The offset in the list of item to return
order string (Optional) Sorts the list in the ascending or the descending order
accept string If defined with the value 'text/csv', a csv file is returned

Return type

GetOrganizationUsageDetailsReply

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]