\DashboardApi

All URIs are relative to https://api.uptrends.com/v4

Method	HTTP request	Description
DashboardCloneDashboard	Post /Dashboard/{dashboardGuid}/Clone	Clone the specified dashboard.
DashboardDeleteDashboard	Delete /Dashboard/{dashboardGuid}	Delete the specified dashboard.
DashboardGetAllDashboards	Get /Dashboard	Returns data for all dashboards.
DashboardGetOneDashboard	Get /Dashboard/{dashboardGuid}	Returns data for the specified dashboard.
DashboardPartiallyUpdateDashboard	Patch /Dashboard/{dashboardGuid}	Partially update the specified dashboard.
DashboardUpdateDashboard	Put /Dashboard/{dashboardGuid}	Update the specified dashboard.

DashboardCloneDashboard

Dashboard DashboardCloneDashboard(ctx, dashboardGuid).Execute()

Clone the specified dashboard.

Example

package main

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

func main() {
    dashboardGuid := "dashboardGuid_example" // string | The guid of the specified dashboard.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DashboardApi.DashboardCloneDashboard(context.Background(), dashboardGuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DashboardApi.DashboardCloneDashboard``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DashboardCloneDashboard`: Dashboard
    fmt.Fprintf(os.Stdout, "Response from `DashboardApi.DashboardCloneDashboard`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
dashboardGuid	string	The guid of the specified dashboard.

Other Parameters

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

Name	Type	Description	Notes

Return type

Dashboard

Authorization

basicauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

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

DashboardDeleteDashboard

DashboardDeleteDashboard(ctx, dashboardGuid).Execute()

Delete the specified dashboard.

Example

package main

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

func main() {
    dashboardGuid := "dashboardGuid_example" // string | The guid of the specified dashboard.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DashboardApi.DashboardDeleteDashboard(context.Background(), dashboardGuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DashboardApi.DashboardDeleteDashboard``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
dashboardGuid	string	The guid of the specified dashboard.

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

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

DashboardGetAllDashboards

[]Dashboard DashboardGetAllDashboards(ctx).Execute()

Returns data for all dashboards.

Example

package main

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

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DashboardApi.DashboardGetAllDashboards(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DashboardApi.DashboardGetAllDashboards``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DashboardGetAllDashboards`: []Dashboard
    fmt.Fprintf(os.Stdout, "Response from `DashboardApi.DashboardGetAllDashboards`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]Dashboard

Authorization

basicauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

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

DashboardGetOneDashboard

Dashboard DashboardGetOneDashboard(ctx, dashboardGuid).Execute()

Returns data for the specified dashboard.

Example

package main

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

func main() {
    dashboardGuid := "dashboardGuid_example" // string | The guid of the specified dashboard.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DashboardApi.DashboardGetOneDashboard(context.Background(), dashboardGuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DashboardApi.DashboardGetOneDashboard``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DashboardGetOneDashboard`: Dashboard
    fmt.Fprintf(os.Stdout, "Response from `DashboardApi.DashboardGetOneDashboard`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
dashboardGuid	string	The guid of the specified dashboard.

Other Parameters

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

Name	Type	Description	Notes

Return type

Dashboard

Authorization

basicauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

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

DashboardPartiallyUpdateDashboard

DashboardPartiallyUpdateDashboard(ctx, dashboardGuid).Dashboard(dashboard).Execute()

Partially update the specified dashboard.

Example

package main

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

func main() {
    dashboardGuid := "dashboardGuid_example" // string | The guid of the specified dashboard.
    dashboard := *openapiclient.NewDashboard() // Dashboard | The details for the dashboard. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DashboardApi.DashboardPartiallyUpdateDashboard(context.Background(), dashboardGuid).Dashboard(dashboard).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DashboardApi.DashboardPartiallyUpdateDashboard``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
dashboardGuid	string	The guid of the specified dashboard.

Other Parameters

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

Name	Type	Description	Notes

dashboard | Dashboard | The details for the dashboard. |

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

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

DashboardUpdateDashboard

DashboardUpdateDashboard(ctx, dashboardGuid).Dashboard(dashboard).Execute()

Update the specified dashboard.

Example

package main

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

func main() {
    dashboardGuid := "dashboardGuid_example" // string | The guid of the specified dashboard.
    dashboard := *openapiclient.NewDashboard() // Dashboard | The details for the dashboard. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DashboardApi.DashboardUpdateDashboard(context.Background(), dashboardGuid).Dashboard(dashboard).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DashboardApi.DashboardUpdateDashboard``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
dashboardGuid	string	The guid of the specified dashboard.

Other Parameters

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

Name	Type	Description	Notes

dashboard | Dashboard | The details for the dashboard. |

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

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

Files

DashboardApi.md

Latest commit

History

DashboardApi.md

File metadata and controls

\DashboardApi

DashboardCloneDashboard

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DashboardDeleteDashboard

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DashboardGetAllDashboards

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DashboardGetOneDashboard

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DashboardPartiallyUpdateDashboard

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DashboardUpdateDashboard

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers