All URIs are relative to https://up.go-adserver.com
| Method | HTTP request | Description |
|---|---|---|
| ApiV1AccountFeaturesGet | Get /api/v1/account/features | Self-service features and their state. |
| ApiV1AccountGet | Get /api/v1/account | Identity check — returns the authenticated user + scopes of the calling key. |
| ApiV1AccountMembershipsGet | Get /api/v1/account/memberships | Accounts this login can act on. |
| ApiV1AccountNoticesGet | Get /api/v1/account/notices | Account notices. |
| ApiV1AccountPendingChangesGet | Get /api/v1/account/pending-changes | Profile changes awaiting verification. |
| ApiV1AccountPreferencesGet | Get /api/v1/account/preferences | Per-member preferences. |
| ApiV1AccountPreferencesKeyPut | Put /api/v1/account/preferences/{key} | Set one preference. |
| ApiV1AccountProfileGet | Get /api/v1/account/profile | The account's contact and company details. |
| ApiV1AccountSalesReferralsGet | Get /api/v1/account/sales-referrals | Your sales referrals — clients assigned to you, their deposits and your commission. |
| ApiV1AccountSettingsGet | Get /api/v1/account/settings | Account settings. |
| ApiV1AccountUiLayoutsGet | Get /api/v1/account/ui-layouts | Saved menu layouts. |
| ApiV1AccountUiLayoutsScopeDelete | Delete /api/v1/account/ui-layouts/{scope} | Reset a menu layout. |
| ApiV1AccountUiLayoutsScopePut | Put /api/v1/account/ui-layouts/{scope} | Save a menu layout. |
| ApiV1AccountUsageGet | Get /api/v1/account/usage | Metered usage for a period. |
| ApiV1AccountUsageSummaryGet | Get /api/v1/account/usage-summary | Inventory counts at a glance. |
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountFeaturesGet(ctx).Execute()
Self-service features and their state.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AccountAPI.ApiV1AccountFeaturesGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountFeaturesGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1AccountFeaturesGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
fmt.Fprintf(os.Stdout, "Response from `AccountAPI.ApiV1AccountFeaturesGet`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiApiV1AccountFeaturesGetRequest struct via the builder pattern
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1AccountGet200Response ApiV1AccountGet(ctx).Execute()
Identity check — returns the authenticated user + scopes of the calling key.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AccountAPI.ApiV1AccountGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1AccountGet`: ApiV1AccountGet200Response
fmt.Fprintf(os.Stdout, "Response from `AccountAPI.ApiV1AccountGet`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiApiV1AccountGetRequest struct via the builder pattern
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountMembershipsGet(ctx).Execute()
Accounts this login can act on.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AccountAPI.ApiV1AccountMembershipsGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountMembershipsGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1AccountMembershipsGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
fmt.Fprintf(os.Stdout, "Response from `AccountAPI.ApiV1AccountMembershipsGet`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiApiV1AccountMembershipsGetRequest struct via the builder pattern
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountNoticesGet(ctx).Execute()
Account notices.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AccountAPI.ApiV1AccountNoticesGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountNoticesGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1AccountNoticesGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
fmt.Fprintf(os.Stdout, "Response from `AccountAPI.ApiV1AccountNoticesGet`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiApiV1AccountNoticesGetRequest struct via the builder pattern
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountPendingChangesGet(ctx).Execute()
Profile changes awaiting verification.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AccountAPI.ApiV1AccountPendingChangesGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountPendingChangesGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1AccountPendingChangesGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
fmt.Fprintf(os.Stdout, "Response from `AccountAPI.ApiV1AccountPendingChangesGet`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiApiV1AccountPendingChangesGetRequest struct via the builder pattern
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountPreferencesGet(ctx).Execute()
Per-member preferences.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AccountAPI.ApiV1AccountPreferencesGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountPreferencesGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1AccountPreferencesGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
fmt.Fprintf(os.Stdout, "Response from `AccountAPI.ApiV1AccountPreferencesGet`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiApiV1AccountPreferencesGetRequest struct via the builder pattern
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1WebhooksIdDelete200Response ApiV1AccountPreferencesKeyPut(ctx, key).ApiV1AccountPreferencesKeyPutRequest(apiV1AccountPreferencesKeyPutRequest).Execute()
Set one preference.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
key := "key_example" // string | Preference key.
apiV1AccountPreferencesKeyPutRequest := *openapiclient.NewApiV1AccountPreferencesKeyPutRequest("Value_example") // ApiV1AccountPreferencesKeyPutRequest |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AccountAPI.ApiV1AccountPreferencesKeyPut(context.Background(), key).ApiV1AccountPreferencesKeyPutRequest(apiV1AccountPreferencesKeyPutRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountPreferencesKeyPut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1AccountPreferencesKeyPut`: ApiV1WebhooksIdDelete200Response
fmt.Fprintf(os.Stdout, "Response from `AccountAPI.ApiV1AccountPreferencesKeyPut`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| key | string | Preference key. |
Other parameters are passed through a pointer to a apiApiV1AccountPreferencesKeyPutRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
apiV1AccountPreferencesKeyPutRequest | ApiV1AccountPreferencesKeyPutRequest | |
ApiV1WebhooksIdDelete200Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountProfileGet(ctx).Execute()
The account's contact and company details.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AccountAPI.ApiV1AccountProfileGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountProfileGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1AccountProfileGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
fmt.Fprintf(os.Stdout, "Response from `AccountAPI.ApiV1AccountProfileGet`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiApiV1AccountProfileGetRequest struct via the builder pattern
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1AccountSalesReferralsGet(ctx).Execute()
Your sales referrals — clients assigned to you, their deposits and your commission.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.AccountAPI.ApiV1AccountSalesReferralsGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountSalesReferralsGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiApiV1AccountSalesReferralsGetRequest struct via the builder pattern
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountSettingsGet(ctx).Execute()
Account settings.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AccountAPI.ApiV1AccountSettingsGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountSettingsGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1AccountSettingsGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
fmt.Fprintf(os.Stdout, "Response from `AccountAPI.ApiV1AccountSettingsGet`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiApiV1AccountSettingsGetRequest struct via the builder pattern
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountUiLayoutsGet(ctx).Execute()
Saved menu layouts.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AccountAPI.ApiV1AccountUiLayoutsGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountUiLayoutsGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1AccountUiLayoutsGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
fmt.Fprintf(os.Stdout, "Response from `AccountAPI.ApiV1AccountUiLayoutsGet`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiApiV1AccountUiLayoutsGetRequest struct via the builder pattern
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1WebhooksIdDelete200Response ApiV1AccountUiLayoutsScopeDelete(ctx, scope).Execute()
Reset a menu layout.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
scope := "scope_example" // string | Layout scope. `nav.user` — the only scope this API accepts.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AccountAPI.ApiV1AccountUiLayoutsScopeDelete(context.Background(), scope).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountUiLayoutsScopeDelete``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1AccountUiLayoutsScopeDelete`: ApiV1WebhooksIdDelete200Response
fmt.Fprintf(os.Stdout, "Response from `AccountAPI.ApiV1AccountUiLayoutsScopeDelete`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| scope | string | Layout scope. `nav.user` — the only scope this API accepts. |
Other parameters are passed through a pointer to a apiApiV1AccountUiLayoutsScopeDeleteRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
ApiV1WebhooksIdDelete200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1WebhooksIdDelete200Response ApiV1AccountUiLayoutsScopePut(ctx, scope).ApiV1AccountUiLayoutsScopePutRequest(apiV1AccountUiLayoutsScopePutRequest).Execute()
Save a menu layout.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
scope := "scope_example" // string | Layout scope, e.g. the panel area the menu belongs to.
apiV1AccountUiLayoutsScopePutRequest := *openapiclient.NewApiV1AccountUiLayoutsScopePutRequest(*openapiclient.NewApiV1AccountUiLayoutsScopePutRequestData([]openapiclient.ApiV1AccountUiLayoutsScopePutRequestDataPatchesInner{*openapiclient.NewApiV1AccountUiLayoutsScopePutRequestDataPatchesInner("Id_example")})) // ApiV1AccountUiLayoutsScopePutRequest |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AccountAPI.ApiV1AccountUiLayoutsScopePut(context.Background(), scope).ApiV1AccountUiLayoutsScopePutRequest(apiV1AccountUiLayoutsScopePutRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountUiLayoutsScopePut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1AccountUiLayoutsScopePut`: ApiV1WebhooksIdDelete200Response
fmt.Fprintf(os.Stdout, "Response from `AccountAPI.ApiV1AccountUiLayoutsScopePut`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| scope | string | Layout scope, e.g. the panel area the menu belongs to. |
Other parameters are passed through a pointer to a apiApiV1AccountUiLayoutsScopePutRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
apiV1AccountUiLayoutsScopePutRequest | ApiV1AccountUiLayoutsScopePutRequest | |
ApiV1WebhooksIdDelete200Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountUsageGet(ctx).Datestart(datestart).Dateend(dateend).DateGroup(dateGroup).Execute()
Metered usage for a period.
package main
import (
"context"
"fmt"
"os"
"time"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
datestart := time.Now() // string | First day (YYYY-MM-DD). Default: 6 days ago. (optional)
dateend := time.Now() // string | Last day (YYYY-MM-DD). Default: today. (optional)
dateGroup := "dateGroup_example" // string | One row per day / month / year, or one total row for the whole range. (optional) (default to "day")
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AccountAPI.ApiV1AccountUsageGet(context.Background()).Datestart(datestart).Dateend(dateend).DateGroup(dateGroup).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountUsageGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1AccountUsageGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
fmt.Fprintf(os.Stdout, "Response from `AccountAPI.ApiV1AccountUsageGet`: %v\n", resp)
}Other parameters are passed through a pointer to a apiApiV1AccountUsageGetRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| datestart | string | First day (YYYY-MM-DD). Default: 6 days ago. | |
| dateend | string | Last day (YYYY-MM-DD). Default: today. | |
| dateGroup | string | One row per day / month / year, or one total row for the whole range. | [default to "day"] |
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1AccountUsageSummaryGet(ctx).Execute()
Inventory counts at a glance.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AccountAPI.ApiV1AccountUsageSummaryGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAPI.ApiV1AccountUsageSummaryGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1AccountUsageSummaryGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
fmt.Fprintf(os.Stdout, "Response from `AccountAPI.ApiV1AccountUsageSummaryGet`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiApiV1AccountUsageSummaryGetRequest struct via the builder pattern
ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]