Skip to content

MonitorCheckAPI.md

Latest commit

 

History

History
1027 lines (687 loc) · 36.5 KB

MonitorCheckAPI.md

File metadata and controls

1027 lines (687 loc) · 36.5 KB

\MonitorCheckAPI

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

Method HTTP request Description
MonitorCheckGetAccountMonitorChecks Get /MonitorCheck Returns all monitor check data.
MonitorCheckGetConcurrentMonitorPartialChecks Get /MonitorCheck/{monitorCheckId}/Concurrent Gets all partial checks for a concurrent monitor check
MonitorCheckGetConsoleLogInfo Get /MonitorCheck/{monitorCheckId}/ConsoleLog Returns console log information for a monitor check.
MonitorCheckGetFilmstrip Get /MonitorCheck/{monitorCheckId}/Filmstrip Gets the filmstrip for a specified monitor check
MonitorCheckGetHttpDetails Get /MonitorCheck/{monitorCheckId}/Http Returns HTTP details for a monitor check.
MonitorCheckGetMonitorCheck Get /MonitorCheck/Monitor/{monitorGuid} Returns monitor check data for a specific monitor.
MonitorCheckGetMonitorGroupData Get /MonitorCheck/MonitorGroup/{monitorGroupGuid} Returns monitor check data for a specific monitor group.
MonitorCheckGetMultistepDetails Get /MonitorCheck/{monitorCheckId}/MultiStepAPI Returns Multi-Step API details for a monitor check.
MonitorCheckGetPageSourceInfo Get /MonitorCheck/{monitorCheckId}/PageSource Returns page source information for a monitor check.
MonitorCheckGetPostmanDetails Get /MonitorCheck/{monitorCheckId}/PostmanAPI Returns Postman API details for a monitor check.
MonitorCheckGetScreenshots Get /MonitorCheck/{monitorCheckId}/Screenshot/{screenshotId} Gets a specific screenshot for a specified monitor check
MonitorCheckGetSingleMonitorCheck Get /MonitorCheck/{monitorCheckId} Returns a single monitor check.
MonitorCheckGetTransactionDetails Get /MonitorCheck/{monitorCheckId}/Transaction Returns transaction step details for a monitor check.
MonitorCheckGetWaterfallInfo Get /MonitorCheck/{monitorCheckId}/Waterfall Returns waterfall information for a monitor check.

MonitorCheckGetAccountMonitorChecks

MonitorCheckResponse MonitorCheckGetAccountMonitorChecks(ctx).ErrorLevel(errorLevel).ShowPartialMeasurements(showPartialMeasurements).Cursor(cursor).Sorting(sorting).Take(take).Start(start).End(end).PresetPeriod(presetPeriod).Execute()

Returns all monitor check data.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	errorLevel := "errorLevel_example" // string | Error level filter that should be applied. (default = NoError and above) (optional)
	showPartialMeasurements := true // bool | Show partial measurements from concurrent monitors (optional)
	cursor := "cursor_example" // string | A cursor value that should be used for traversing the dataset. (optional)
	sorting := "sorting_example" // string | Sorting direction based on timestamp. (optional) (default to "Descending")
	take := int32(56) // int32 | The number of records to return (Max value = 100) (optional) (default to 100)
	start := TODO // interface{} | The start of a custom period (can't be used together with the PresetPeriod parameter) (optional)
	end := TODO // interface{} | The end of a custom period (optional)
	presetPeriod := "presetPeriod_example" // string | The requested time period. (optional) (default to "Last24Hours")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MonitorCheckAPI.MonitorCheckGetAccountMonitorChecks(context.Background()).ErrorLevel(errorLevel).ShowPartialMeasurements(showPartialMeasurements).Cursor(cursor).Sorting(sorting).Take(take).Start(start).End(end).PresetPeriod(presetPeriod).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MonitorCheckAPI.MonitorCheckGetAccountMonitorChecks``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `MonitorCheckGetAccountMonitorChecks`: MonitorCheckResponse
	fmt.Fprintf(os.Stdout, "Response from `MonitorCheckAPI.MonitorCheckGetAccountMonitorChecks`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
errorLevel string Error level filter that should be applied. (default = NoError and above)
showPartialMeasurements bool Show partial measurements from concurrent monitors
cursor string A cursor value that should be used for traversing the dataset.
sorting string Sorting direction based on timestamp. [default to "Descending"]
take int32 The number of records to return (Max value = 100) [default to 100]
start interface{} The start of a custom period (can't be used together with the PresetPeriod parameter)
end interface{} The end of a custom period
presetPeriod string The requested time period. [default to "Last24Hours"]

Return type

MonitorCheckResponse

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]

MonitorCheckGetConcurrentMonitorPartialChecks

MonitorCheckResponse MonitorCheckGetConcurrentMonitorPartialChecks(ctx, monitorCheckId).Execute()

Gets all partial checks for a concurrent monitor check

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	monitorCheckId := int64(789) // int64 | The monitor check Id to get the partial checks for.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorCheckId int64 The monitor check Id to get the partial checks for.

Other Parameters

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

Name Type Description Notes

Return type

MonitorCheckResponse

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]

MonitorCheckGetConsoleLogInfo

ConsoleLogResponse MonitorCheckGetConsoleLogInfo(ctx, monitorCheckId).Step(step).Execute()

Returns console log information for a monitor check.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	monitorCheckId := int64(789) // int64 | The monitor check Id to get the detailed data for.
	step := int32(56) // int32 | For transactions only: the transaction step to get the console log for. (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorCheckId int64 The monitor check Id to get the detailed data for.

Other Parameters

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

Name Type Description Notes

step | int32 | For transactions only: the transaction step to get the console log for. |

Return type

ConsoleLogResponse

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]

MonitorCheckGetFilmstrip

FilmstripResponse MonitorCheckGetFilmstrip(ctx, monitorCheckId).Step(step).Execute()

Gets the filmstrip for a specified monitor check

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	monitorCheckId := int64(789) // int64 | The monitor check Id to get the filmstrip data for.
	step := int32(56) // int32 | For transactions only: The number of the step to get the filmstrip data for. (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorCheckId int64 The monitor check Id to get the filmstrip data for.

Other Parameters

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

Name Type Description Notes

step | int32 | For transactions only: The number of the step to get the filmstrip data for. |

Return type

FilmstripResponse

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]

MonitorCheckGetHttpDetails

HttpDetailsResponse MonitorCheckGetHttpDetails(ctx, monitorCheckId).Execute()

Returns HTTP details for a monitor check.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	monitorCheckId := int64(789) // int64 | The monitor check Id to get the detailed data for.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorCheckId int64 The monitor check Id to get the detailed data for.

Other Parameters

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

Name Type Description Notes

Return type

HttpDetailsResponse

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]

MonitorCheckGetMonitorCheck

MonitorCheckResponse MonitorCheckGetMonitorCheck(ctx, monitorGuid).ErrorLevel(errorLevel).ShowPartialMeasurements(showPartialMeasurements).Cursor(cursor).Sorting(sorting).Take(take).Start(start).End(end).PresetPeriod(presetPeriod).Execute()

Returns monitor check data for a specific monitor.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	monitorGuid := "monitorGuid_example" // string | The Guid of the monitor to get monitor checks for.
	errorLevel := "errorLevel_example" // string | Error level filter that should be applied. (default = NoError and above) (optional)
	showPartialMeasurements := true // bool | Show partial measurements from concurrent monitors (optional)
	cursor := "cursor_example" // string | A cursor value that should be used for traversing the dataset. (optional)
	sorting := "sorting_example" // string | Sorting direction based on timestamp. (optional) (default to "Descending")
	take := int32(56) // int32 | The number of records to return (Max value = 100) (optional) (default to 100)
	start := TODO // interface{} | The start of a custom period (can't be used together with the PresetPeriod parameter) (optional)
	end := TODO // interface{} | The end of a custom period (optional)
	presetPeriod := "presetPeriod_example" // string | The requested time period. (optional) (default to "Last24Hours")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MonitorCheckAPI.MonitorCheckGetMonitorCheck(context.Background(), monitorGuid).ErrorLevel(errorLevel).ShowPartialMeasurements(showPartialMeasurements).Cursor(cursor).Sorting(sorting).Take(take).Start(start).End(end).PresetPeriod(presetPeriod).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MonitorCheckAPI.MonitorCheckGetMonitorCheck``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `MonitorCheckGetMonitorCheck`: MonitorCheckResponse
	fmt.Fprintf(os.Stdout, "Response from `MonitorCheckAPI.MonitorCheckGetMonitorCheck`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGuid string The Guid of the monitor to get monitor checks for.

Other Parameters

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

Name Type Description Notes

errorLevel | string | Error level filter that should be applied. (default = NoError and above) | showPartialMeasurements | bool | Show partial measurements from concurrent monitors | cursor | string | A cursor value that should be used for traversing the dataset. | sorting | string | Sorting direction based on timestamp. | [default to "Descending"] take | int32 | The number of records to return (Max value = 100) | [default to 100] start | interface{} | The start of a custom period (can't be used together with the PresetPeriod parameter) | end | interface{} | The end of a custom period | presetPeriod | string | The requested time period. | [default to "Last24Hours"]

Return type

MonitorCheckResponse

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]

MonitorCheckGetMonitorGroupData

MonitorCheckResponse MonitorCheckGetMonitorGroupData(ctx, monitorGroupGuid).ErrorLevel(errorLevel).ShowPartialMeasurements(showPartialMeasurements).Cursor(cursor).Sorting(sorting).Take(take).Start(start).End(end).PresetPeriod(presetPeriod).Execute()

Returns monitor check data for a specific monitor group.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	monitorGroupGuid := "monitorGroupGuid_example" // string | The Guid of the monitor group to get monitor checks for.
	errorLevel := "errorLevel_example" // string | Error level filter that should be applied. (default = NoError and above) (optional)
	showPartialMeasurements := true // bool | Show partial measurements from concurrent monitors (optional)
	cursor := "cursor_example" // string | A cursor value that should be used for traversing the dataset. (optional)
	sorting := "sorting_example" // string | Sorting direction based on timestamp. (optional) (default to "Descending")
	take := int32(56) // int32 | The number of records to return (Max value = 100) (optional) (default to 100)
	start := TODO // interface{} | The start of a custom period (can't be used together with the PresetPeriod parameter) (optional)
	end := TODO // interface{} | The end of a custom period (optional)
	presetPeriod := "presetPeriod_example" // string | The requested time period. (optional) (default to "Last24Hours")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MonitorCheckAPI.MonitorCheckGetMonitorGroupData(context.Background(), monitorGroupGuid).ErrorLevel(errorLevel).ShowPartialMeasurements(showPartialMeasurements).Cursor(cursor).Sorting(sorting).Take(take).Start(start).End(end).PresetPeriod(presetPeriod).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MonitorCheckAPI.MonitorCheckGetMonitorGroupData``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `MonitorCheckGetMonitorGroupData`: MonitorCheckResponse
	fmt.Fprintf(os.Stdout, "Response from `MonitorCheckAPI.MonitorCheckGetMonitorGroupData`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorGroupGuid string The Guid of the monitor group to get monitor checks for.

Other Parameters

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

Name Type Description Notes

errorLevel | string | Error level filter that should be applied. (default = NoError and above) | showPartialMeasurements | bool | Show partial measurements from concurrent monitors | cursor | string | A cursor value that should be used for traversing the dataset. | sorting | string | Sorting direction based on timestamp. | [default to "Descending"] take | int32 | The number of records to return (Max value = 100) | [default to 100] start | interface{} | The start of a custom period (can't be used together with the PresetPeriod parameter) | end | interface{} | The end of a custom period | presetPeriod | string | The requested time period. | [default to "Last24Hours"]

Return type

MonitorCheckResponse

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]

MonitorCheckGetMultistepDetails

MsaDetailsResponse MonitorCheckGetMultistepDetails(ctx, monitorCheckId).Execute()

Returns Multi-Step API details for a monitor check.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	monitorCheckId := int64(789) // int64 | The monitor check Id to get the detailed data for.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorCheckId int64 The monitor check Id to get the detailed data for.

Other Parameters

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

Name Type Description Notes

Return type

MsaDetailsResponse

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]

MonitorCheckGetPageSourceInfo

PageSourceResponse MonitorCheckGetPageSourceInfo(ctx, monitorCheckId).Step(step).Execute()

Returns page source information for a monitor check.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	monitorCheckId := int64(789) // int64 | The monitor check Id to get the detailed data for.
	step := int32(56) // int32 | For transactions only: the transaction step to get the page source for. (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorCheckId int64 The monitor check Id to get the detailed data for.

Other Parameters

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

Name Type Description Notes

step | int32 | For transactions only: the transaction step to get the page source for. |

Return type

PageSourceResponse

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]

MonitorCheckGetPostmanDetails

MsaDetailsResponse MonitorCheckGetPostmanDetails(ctx, monitorCheckId).Execute()

Returns Postman API details for a monitor check.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	monitorCheckId := int64(789) // int64 | The monitor check Id to get the detailed data for.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorCheckId int64 The monitor check Id to get the detailed data for.

Other Parameters

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

Name Type Description Notes

Return type

MsaDetailsResponse

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]

MonitorCheckGetScreenshots

ScreenshotResponse MonitorCheckGetScreenshots(ctx, monitorCheckId, screenshotId).Execute()

Gets a specific screenshot for a specified monitor check

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	monitorCheckId := int64(789) // int64 | The monitor check Id to get the screenshot data for.
	screenshotId := "screenshotId_example" // string | The screenshot Id of the screenshot to get.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorCheckId int64 The monitor check Id to get the screenshot data for.
screenshotId string The screenshot Id of the screenshot to get.

Other Parameters

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

Name Type Description Notes

Return type

ScreenshotResponse

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]

MonitorCheckGetSingleMonitorCheck

SingleMonitorCheckResponse MonitorCheckGetSingleMonitorCheck(ctx, monitorCheckId).Execute()

Returns a single monitor check.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	monitorCheckId := int64(789) // int64 | The Id of the monitor check to get the data for.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorCheckId int64 The Id of the monitor check to get the data for.

Other Parameters

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

Name Type Description Notes

Return type

SingleMonitorCheckResponse

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]

MonitorCheckGetTransactionDetails

TransactionDetailsResponse MonitorCheckGetTransactionDetails(ctx, monitorCheckId).Execute()

Returns transaction step details for a monitor check.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	monitorCheckId := int64(789) // int64 | The monitor check Id to get the detailed data for.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorCheckId int64 The monitor check Id to get the detailed data for.

Other Parameters

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

Name Type Description Notes

Return type

TransactionDetailsResponse

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]

MonitorCheckGetWaterfallInfo

WaterfallResponse MonitorCheckGetWaterfallInfo(ctx, monitorCheckId).Step(step).Execute()

Returns waterfall information for a monitor check.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/JetManiack/go-uptrends-api"
)

func main() {
	monitorCheckId := int64(789) // int64 | The monitor check Id to get the detailed data for.
	step := int32(56) // int32 | For transaction waterfalls only: the transaction step to get the waterfall for. (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
monitorCheckId int64 The monitor check Id to get the detailed data for.

Other Parameters

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

Name Type Description Notes

step | int32 | For transaction waterfalls only: the transaction step to get the waterfall for. |

Return type

WaterfallResponse

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]