Skip to content

README.md

Latest commit

 

History

History
142 lines (111 loc) · 8.98 KB

README.md

File metadata and controls

142 lines (111 loc) · 8.98 KB
Raw

Analytics

Overview

Available Operations

GetOrganization

Get Org level analytics

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
    )

    res, err := s.Analytics.GetOrganization(ctx, "<value>", "<value>", nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
from string ✔️ N/A
to string ✔️ N/A
teamID *string ➖ N/A
userID *string ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.AnalyticsGetOrgAnalyticsResponse, error

Errors

Error Type Status Code Content Type
apierrors.BadRequestError 400 application/json
apierrors.UnauthorizedError 401 application/json
apierrors.PaymentRequiredError 402 application/json
apierrors.ForbiddenError 403 application/json
apierrors.NotFoundError 404 application/json
apierrors.ConflictError 409 application/json
apierrors.UnprocessableEntityError 422 application/json
apierrors.InternalServerError 500 application/json
apierrors.BadGatewayError 502 application/json
apierrors.ServiceUnavailableError 503 application/json
apierrors.GatewayTimeoutError 504 application/json
apierrors.APIError 4XX, 5XX */*

GetTeam

Get Team level analytics

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/squadcast-sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
    )

    res, err := s.Analytics.GetTeam(ctx, operations.AnalyticsGetTeamAnalyticsRequest{
        OwnerID: "<id>",
        From: "<value>",
        To: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.AnalyticsGetTeamAnalyticsRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.AnalyticsGetTeamAnalyticsResponse, error

Errors

Error Type Status Code Content Type
apierrors.BadRequestError 400 application/json
apierrors.UnauthorizedError 401 application/json
apierrors.PaymentRequiredError 402 application/json
apierrors.ForbiddenError 403 application/json
apierrors.NotFoundError 404 application/json
apierrors.ConflictError 409 application/json
apierrors.UnprocessableEntityError 422 application/json
apierrors.InternalServerError 500 application/json
apierrors.BadGatewayError 502 application/json
apierrors.ServiceUnavailableError 503 application/json
apierrors.GatewayTimeoutError 504 application/json
apierrors.APIError 4XX, 5XX */*