Skip to content

Latest commit

 

History

History
406 lines (265 loc) · 18.2 KB

MonitorCheckApi.md

File metadata and controls

406 lines (265 loc) · 18.2 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.
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.
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, optional) Returns all monitor check data.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MonitorCheckApiMonitorCheckGetAccountMonitorChecksOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MonitorCheckApiMonitorCheckGetAccountMonitorChecksOpts struct

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

Return type

MonitorCheckResponse

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]

MonitorCheckGetConcurrentMonitorPartialChecks

MonitorCheckResponse MonitorCheckGetConcurrentMonitorPartialChecks(ctx, monitorCheckId) Gets all partial checks for a concurrent monitor check

Required 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.

Return type

MonitorCheckResponse

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]

MonitorCheckGetConsoleLogInfo

WaterfallResponse MonitorCheckGetConsoleLogInfo(ctx, monitorCheckId, optional) Returns console log information for a monitor check.

Required 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.
optional *MonitorCheckApiMonitorCheckGetConsoleLogInfoOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MonitorCheckApiMonitorCheckGetConsoleLogInfoOpts struct

Name Type Description Notes

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

Return type

WaterfallResponse

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]

MonitorCheckGetHttpDetails

HttpDetailsResponse MonitorCheckGetHttpDetails(ctx, monitorCheckId) Returns HTTP details for a monitor check.

Required 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.

Return type

HttpDetailsResponse

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]

MonitorCheckGetMonitorCheck

MonitorCheckResponse MonitorCheckGetMonitorCheck(ctx, monitorGuid, optional) Returns monitor check data for a specific monitor.

Required 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.
optional *MonitorCheckApiMonitorCheckGetMonitorCheckOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MonitorCheckApiMonitorCheckGetMonitorCheckOpts struct

Name Type Description Notes

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

Return type

MonitorCheckResponse

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]

MonitorCheckGetMonitorGroupData

MonitorCheckResponse MonitorCheckGetMonitorGroupData(ctx, monitorGroupGuid, optional) Returns monitor check data for a specific monitor group.

Required 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.
optional *MonitorCheckApiMonitorCheckGetMonitorGroupDataOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MonitorCheckApiMonitorCheckGetMonitorGroupDataOpts struct

Name Type Description Notes

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

Return type

MonitorCheckResponse

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]

MonitorCheckGetMultistepDetails

MsaDetailsResponse MonitorCheckGetMultistepDetails(ctx, monitorCheckId) Returns Multi-Step API details for a monitor check.

Required 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.

Return type

MsaDetailsResponse

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]

MonitorCheckGetPageSourceInfo

WaterfallResponse MonitorCheckGetPageSourceInfo(ctx, monitorCheckId, optional) Returns page source information for a monitor check.

Required 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.
optional *MonitorCheckApiMonitorCheckGetPageSourceInfoOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MonitorCheckApiMonitorCheckGetPageSourceInfoOpts struct

Name Type Description Notes

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

Return type

WaterfallResponse

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]

MonitorCheckGetScreenshots

ScreenshotResponse MonitorCheckGetScreenshots(ctx, monitorCheckId, screenshotId) Gets a specific screenshot for a specified monitor check

Required 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.

Return type

ScreenshotResponse

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]

MonitorCheckGetSingleMonitorCheck

SingleMonitorCheckResponse MonitorCheckGetSingleMonitorCheck(ctx, monitorCheckId) Returns a single monitor check.

Required 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.

Return type

SingleMonitorCheckResponse

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]

MonitorCheckGetTransactionDetails

TransactionDetailsResponse MonitorCheckGetTransactionDetails(ctx, monitorCheckId) Returns transaction step details for a monitor check.

Required 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.

Return type

TransactionDetailsResponse

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]

MonitorCheckGetWaterfallInfo

WaterfallResponse MonitorCheckGetWaterfallInfo(ctx, monitorCheckId, optional) Returns waterfall information for a monitor check.

Required 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.
optional *MonitorCheckApiMonitorCheckGetWaterfallInfoOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MonitorCheckApiMonitorCheckGetWaterfallInfoOpts struct

Name Type Description Notes

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

Return type

WaterfallResponse

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]