ClientInsightAPI

All URIs are relative to https://use1-omada-northbound.tplinkcloud.com

Method	HTTP request	Description
GetApDensity	Get /openapi/v1/{omadacId}/sites/{siteId}/dashboard/ap-density	Get ap density.
GetClientActivity	Get /openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-activity	Get client activity
GetClientNumberForCustomerList	Post /openapi/v1/msp/{mspId}/customers/client-count	Get the Msp customers' client count.
GetClientsAssociationActivities	Get /openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-association-activities	Get clients association activities.
GetClientsAssociationTimeDistribution	Get /openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-association-time-distribution	Get clients association time distribution.
GetClientsBandDistribution	Get /openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-signal-distribution	Get clients signal distribution.
GetClientsBubble	Get /openapi/v1/{omadacId}/sites/{siteId}/dashboard/clients-bubble	Get clients bubble.
GetClientsDistribution	Get /openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-distribution	Get client distribution.
GetClientsFreqDistribution	Get /openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-freq-distribution	Get clients freq distribution.
GetClientsRssiDistribution	Get /openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-rssi-distribution	Get clients rssi distribution.
GetClientsSsidDistribution	Get /openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-ssid-distribution	Get clients ssid distribution.
GetCurrentClientNum	Get /openapi/v1/{omadacId}/sites/{siteId}/dashboard/current-client-num	Get current client number.
GetDeviceClient5MinStat	Post /openapi/v1/{omadacId}/sites/{siteId}/stat/{deviceMac}/client-stat-5min	Get device client 5 min stat.
GetGridKnownClients	Get /openapi/v1/{omadacId}/sites/{siteId}/insight/clients	Get known clients list
GetGridPastConnections	Get /openapi/v1/{omadacId}/sites/{siteId}/insight/past-connection	Get client past connection list
GetLongestClientUptime	Get /openapi/v1/{omadacId}/sites/{siteId}/dashboard/longest-uptime	Get longest client uptime.
GetMostActiveClients	Get /openapi/v1/{omadacId}/sites/{siteId}/dashboard/active-clients	Get most active client.
GetMspDashboardOverall	Get /openapi/v1/msp/{mspId}/dashboard/client/overview-diagram	Get the msp overview diagram of client.
GetPastClientNum	Get /openapi/v1/{omadacId}/sites/{siteId}/dashboard/past-client-num	Get past client number.
GetStackClientStat	Post /openapi/v1/{omadacId}/sites/{siteId}/stat/stacks/{stackId}/client-stat	Get stack client stat.

GetApDensity

OperationResponseEapRssiChannelDistributionVO GetApDensity(ctx, omadacId, siteId).Execute()

Get ap density.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseEapRssiChannelDistributionVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetClientActivity

OperationResponseListClientActivitiesVO GetClientActivity(ctx, omadacId, siteId).Start(start).End(end).Execute()

Get client activity

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    start := int64(789) // int64 | Start timestamp, in seconds, such as 1682000000 (optional)
    end := int64(789) // int64 | End timestamp, in seconds, such as 1682000000 (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ClientInsightAPI.GetClientActivity(context.Background(), omadacId, siteId).Start(start).End(end).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ClientInsightAPI.GetClientActivity``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetClientActivity`: OperationResponseListClientActivitiesVO
    fmt.Fprintf(os.Stdout, "Response from `ClientInsightAPI.GetClientActivity`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

start | int64 | Start timestamp, in seconds, such as 1682000000 | end | int64 | End timestamp, in seconds, such as 1682000000 |

Return type

OperationResponseListClientActivitiesVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetClientNumberForCustomerList

OperationResponseListCustomerListClientNumVO GetClientNumberForCustomerList(ctx, mspId).CustomerQueryOpenApiVO(customerQueryOpenApiVO).Execute()

Get the Msp customers' client count.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    mspId := "mspId_example" // string | MSP ID
    customerQueryOpenApiVO := *openapiclient.NewCustomerQueryOpenApiVO([]string{"CustomerIds_example"}) // CustomerQueryOpenApiVO | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
mspId	string	MSP ID

Other Parameters

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

Name	Type	Description	Notes

customerQueryOpenApiVO | CustomerQueryOpenApiVO | |

Return type

OperationResponseListCustomerListClientNumVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

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

GetClientsAssociationActivities

OperationResponseClientSummaryVO GetClientsAssociationActivities(ctx, omadacId, siteId).Start(start).End(end).Execute()

Get clients association activities.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    start := int64(789) // int64 | Start timestamp, in seconds, such as 1682000000
    end := int64(789) // int64 | End timestamp, in seconds, such as 1682000000

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ClientInsightAPI.GetClientsAssociationActivities(context.Background(), omadacId, siteId).Start(start).End(end).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ClientInsightAPI.GetClientsAssociationActivities``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetClientsAssociationActivities`: OperationResponseClientSummaryVO
    fmt.Fprintf(os.Stdout, "Response from `ClientInsightAPI.GetClientsAssociationActivities`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

start | int64 | Start timestamp, in seconds, such as 1682000000 | end | int64 | End timestamp, in seconds, such as 1682000000 |

Return type

OperationResponseClientSummaryVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetClientsAssociationTimeDistribution

OperationResponseClientAssociationTimeDistributionVO GetClientsAssociationTimeDistribution(ctx, omadacId, siteId).Start(start).End(end).Execute()

Get clients association time distribution.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    start := int64(789) // int64 | Start timestamp, in seconds, such as 1682000000
    end := int64(789) // int64 | End timestamp, in seconds, such as 1682000000

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ClientInsightAPI.GetClientsAssociationTimeDistribution(context.Background(), omadacId, siteId).Start(start).End(end).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ClientInsightAPI.GetClientsAssociationTimeDistribution``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetClientsAssociationTimeDistribution`: OperationResponseClientAssociationTimeDistributionVO
    fmt.Fprintf(os.Stdout, "Response from `ClientInsightAPI.GetClientsAssociationTimeDistribution`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

start | int64 | Start timestamp, in seconds, such as 1682000000 | end | int64 | End timestamp, in seconds, such as 1682000000 |

Return type

OperationResponseClientAssociationTimeDistributionVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetClientsBandDistribution

OperationResponseClientSignalDistributionVO GetClientsBandDistribution(ctx, omadacId, siteId).Execute()

Get clients signal distribution.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseClientSignalDistributionVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetClientsBubble

OperationResponseListActiveClientBubbleVO GetClientsBubble(ctx, omadacId, siteId).Execute()

Get clients bubble.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseListActiveClientBubbleVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetClientsDistribution

OperationResponseDashboardDistributionVO GetClientsDistribution(ctx, omadacId, siteId).Execute()

Get client distribution.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseDashboardDistributionVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetClientsFreqDistribution

OperationResponseClientSummaryVO GetClientsFreqDistribution(ctx, omadacId, siteId).Execute()

Get clients freq distribution.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseClientSummaryVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetClientsRssiDistribution

OperationResponseClientRssiChannelDistributionVO GetClientsRssiDistribution(ctx, omadacId, siteId).Execute()

Get clients rssi distribution.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseClientRssiChannelDistributionVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetClientsSsidDistribution

OperationResponseClientSummaryVO GetClientsSsidDistribution(ctx, omadacId, siteId).Execute()

Get clients ssid distribution.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseClientSummaryVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetCurrentClientNum

OperationResponseClientSummaryVO GetCurrentClientNum(ctx, omadacId, siteId).Execute()

Get current client number.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseClientSummaryVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetDeviceClient5MinStat

OperationResponseListDeviceClientStatVO GetDeviceClient5MinStat(ctx, omadacId, siteId, deviceMac).DeviceType(deviceType).DeviceClientStatQueryOpenApiVO(deviceClientStatQueryOpenApiVO).Execute()

Get device client 5 min stat.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    deviceType := "deviceType_example" // string | Device type.
    deviceClientStatQueryOpenApiVO := *openapiclient.NewDeviceClientStatQueryOpenApiVO([]string{"Attrs_example"}, int64(123), int64(123)) // DeviceClientStatQueryOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ClientInsightAPI.GetDeviceClient5MinStat(context.Background(), omadacId, siteId, deviceMac).DeviceType(deviceType).DeviceClientStatQueryOpenApiVO(deviceClientStatQueryOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ClientInsightAPI.GetDeviceClient5MinStat``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDeviceClient5MinStat`: OperationResponseListDeviceClientStatVO
    fmt.Fprintf(os.Stdout, "Response from `ClientInsightAPI.GetDeviceClient5MinStat`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

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

Name	Type	Description	Notes

deviceType | string | Device type. | deviceClientStatQueryOpenApiVO | DeviceClientStatQueryOpenApiVO | |

Return type

OperationResponseListDeviceClientStatVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

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

GetGridKnownClients

OperationResponseGridVOKnownClientVO GetGridKnownClients(ctx, omadacId, siteId).Page(page).PageSize(pageSize).SortsLastSeen(sortsLastSeen).FiltersTimeStart(filtersTimeStart).FiltersTimeEnd(filtersTimeEnd).FiltersGuest(filtersGuest).SearchKey(searchKey).Execute()

Get known clients list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    sortsLastSeen := "sortsLastSeen_example" // string | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect (optional)
    filtersTimeStart := "filtersTimeStart_example" // string | Filter query parameters, support field time range: start timestamp (ms). (optional)
    filtersTimeEnd := "filtersTimeEnd_example" // string | Filter query parameters, support field time range: end timestamp (ms). (optional)
    filtersGuest := "filtersGuest_example" // string | Filter query parameters, support field guest: true/false. (optional)
    searchKey := "searchKey_example" // string | Fuzzy query parameters, support field name,mac,ssid. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ClientInsightAPI.GetGridKnownClients(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).SortsLastSeen(sortsLastSeen).FiltersTimeStart(filtersTimeStart).FiltersTimeEnd(filtersTimeEnd).FiltersGuest(filtersGuest).SearchKey(searchKey).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ClientInsightAPI.GetGridKnownClients``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetGridKnownClients`: OperationResponseGridVOKnownClientVO
    fmt.Fprintf(os.Stdout, "Response from `ClientInsightAPI.GetGridKnownClients`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

page | int32 | Start page number. Start from 1. | pageSize | int32 | Number of entries per page. It should be within the range of 1–1000. | sortsLastSeen | string | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect | filtersTimeStart | string | Filter query parameters, support field time range: start timestamp (ms). | filtersTimeEnd | string | Filter query parameters, support field time range: end timestamp (ms). | filtersGuest | string | Filter query parameters, support field guest: true/false. | searchKey | string | Fuzzy query parameters, support field name,mac,ssid. |

Return type

OperationResponseGridVOKnownClientVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetGridPastConnections

OperationResponseGridVOClientHistoryInfo GetGridPastConnections(ctx, omadacId, siteId).Page(page).PageSize(pageSize).SortsLastSeen(sortsLastSeen).FiltersTimeStart(filtersTimeStart).FiltersTimeEnd(filtersTimeEnd).FiltersGuest(filtersGuest).SearchKey(searchKey).Execute()

Get client past connection list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    sortsLastSeen := "sortsLastSeen_example" // string | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect (optional)
    filtersTimeStart := "filtersTimeStart_example" // string | Filter query parameters, support field time range: start timestamp (ms). (optional)
    filtersTimeEnd := "filtersTimeEnd_example" // string | Filter query parameters, support field time range: end timestamp (ms). (optional)
    filtersGuest := "filtersGuest_example" // string | Filter query parameters, support field guest: true/false. (optional)
    searchKey := "searchKey_example" // string | Fuzzy query parameters, support field name,mac,ssid. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ClientInsightAPI.GetGridPastConnections(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).SortsLastSeen(sortsLastSeen).FiltersTimeStart(filtersTimeStart).FiltersTimeEnd(filtersTimeEnd).FiltersGuest(filtersGuest).SearchKey(searchKey).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ClientInsightAPI.GetGridPastConnections``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetGridPastConnections`: OperationResponseGridVOClientHistoryInfo
    fmt.Fprintf(os.Stdout, "Response from `ClientInsightAPI.GetGridPastConnections`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

page | int32 | Start page number. Start from 1. | pageSize | int32 | Number of entries per page. It should be within the range of 1–1000. | sortsLastSeen | string | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect | filtersTimeStart | string | Filter query parameters, support field time range: start timestamp (ms). | filtersTimeEnd | string | Filter query parameters, support field time range: end timestamp (ms). | filtersGuest | string | Filter query parameters, support field guest: true/false. | searchKey | string | Fuzzy query parameters, support field name,mac,ssid. |

Return type

OperationResponseGridVOClientHistoryInfo

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetLongestClientUptime

OperationResponseClientSummaryVO GetLongestClientUptime(ctx, omadacId, siteId).Execute()

Get longest client uptime.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseClientSummaryVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetMostActiveClients

OperationResponseListActiveClientVO GetMostActiveClients(ctx, omadacId, siteId).Execute()

Get most active client.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseListActiveClientVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetMspDashboardOverall

OperationResponseMspClientOverallVO GetMspDashboardOverall(ctx, mspId).Execute()

Get the msp overview diagram of client.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    mspId := "mspId_example" // string | MSP ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
mspId	string	MSP ID

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseMspClientOverallVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetPastClientNum

OperationResponseClientSummaryVO GetPastClientNum(ctx, omadacId, siteId).Start(start).End(end).Execute()

Get past client number.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    start := int64(789) // int64 | Start timestamp, in seconds, such as 1682000000
    end := int64(789) // int64 | End timestamp, in seconds, such as 1682000000

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ClientInsightAPI.GetPastClientNum(context.Background(), omadacId, siteId).Start(start).End(end).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ClientInsightAPI.GetPastClientNum``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetPastClientNum`: OperationResponseClientSummaryVO
    fmt.Fprintf(os.Stdout, "Response from `ClientInsightAPI.GetPastClientNum`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

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

Name	Type	Description	Notes

start | int64 | Start timestamp, in seconds, such as 1682000000 | end | int64 | End timestamp, in seconds, such as 1682000000 |

Return type

OperationResponseClientSummaryVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetStackClientStat

OperationResponseListDeviceClientStatVO GetStackClientStat(ctx, omadacId, siteId, stackId).DeviceClientStatQueryOpenApiVO(deviceClientStatQueryOpenApiVO).Execute()

Get stack client stat.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    stackId := "stackId_example" // string | Stack ID
    deviceClientStatQueryOpenApiVO := *openapiclient.NewDeviceClientStatQueryOpenApiVO([]string{"Attrs_example"}, int64(123), int64(123)) // DeviceClientStatQueryOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ClientInsightAPI.GetStackClientStat(context.Background(), omadacId, siteId, stackId).DeviceClientStatQueryOpenApiVO(deviceClientStatQueryOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ClientInsightAPI.GetStackClientStat``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetStackClientStat`: OperationResponseListDeviceClientStatVO
    fmt.Fprintf(os.Stdout, "Response from `ClientInsightAPI.GetStackClientStat`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
stackId	string	Stack ID

Other Parameters

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

Name	Type	Description	Notes

deviceClientStatQueryOpenApiVO | DeviceClientStatQueryOpenApiVO | |

Return type

OperationResponseListDeviceClientStatVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

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