/
api_summary_average.go
199 lines (168 loc) · 21.4 KB
/
api_summary_average.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/*
Pingdom Public API
# Welcome to the Pingdom API! The Pingdom API is a way for you to automate your interaction with the Pingdom system. With the API, you can create your own scripts or applications with most of the functionality you can find inside the Pingdom control panel. The Pingdom API is RESTful and HTTP-based. Basically, this means that the communication is made through normal HTTP requests. # Authentication Authentication is needed in order to use the Pingdom API, and for this a Pingdom API Token is required. You generate your Pingdom API Token inside My Pingdom. The Pingdom API Token has a property called “Access level” to define its permissions. All operations that create or modify something (e.g. checks) need the Read/Write permission. If you only need to read data using the API token, we recommend to set the access level to “Read access”. The authentication method for using tokens is HTTP Bearer Authentication (encrypted over HTTPS). This means that you will provide your token every time you make a request. No sessions are used. Request ``` GET /checks HTTP/1.1 Host: api.pingdom.com Authorization: Bearer ofOhK18Ca6w4S_XmInGv0QPkqly-rbRBBoHsp_2FEH5QnIbH0VZhRPO3tlvrjMIKQ36VapX ``` Response ``` HTTP/1.1 200 OK Content-Length: 13 Content-Type: application/json {\"checks\":[]} ``` ## Basic Auth For compatibility reasons, the Pingdom API allows to use HTTP Basic Authentication with tokens. In cases where this is necessary, input the API token as the username and leave the password field empty. An example request of how that would look like with the following API token: ofOhK18Ca6w4S_XmInGv0QPkqly-rbRBBoHsp_2FEH5QnIbH0VZhRPO3tlvrjMIKQ36VapX ``` GET /checks HTTP/1.1 Host: api.pingdom.com Authorization: Basic b2ZPaEsxOENhNnc0U19YbUluR3YwUVBrcWx5LXJiUkJCb0hzcF8yRkVINVFuSWJIMFZaaFJQTzN0bHZyak1JS1EzNlZhcFg6 ``` # Server Address The base server address is: https://api.pingdom.com Please note that HTTPS is required. You will not be able to connect through unencrypted HTTP. # Providing Parameters GET requests should provide their parameters as a query string, part of the URL. POST, PUT and DELETE requests should provide their parameters as a JSON. This should be part of the request body. Remember to add the proper content type header to the request: `Content-Type: application/json`. We still support providing parameters as a query string for POST, PUT and DELETE requests, but we recommend using JSON going forward. If you are using query strings, they should be part of the body, URL or a combination. The encoding of the query string should be standard URL-encoding, as provided by various programming libraries. When using `requests` library for Python, use `json` parameter instead of `data`. Due to the inner mechanisms of requests.post() etc. some endpoints may return responses not conforming to the documentation when dealing with `data` body. # HTTP/1.1 Status Code Definitions The HTTP status code returned by a successful API request is defined in the documentation for that method. Usually, this will be 200 OK. If something goes wrong, other codes may be returned. The API uses standard HTTP/1.1 status codes defined by [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html). # JSON Responses All responses are sent JSON-encoded. The specific responses (successful ones) are described in the documentation section for each method. However, if something goes wrong, our standard JSON error message (together with an appropriate status code) follows this format: ``` { \"error\": { \"statuscode\": 403, \"statusdesc\": \"Forbidden\", \"errormessage\":\" Something went wrong! This string describes what happened.\" } } ``` See http://en.wikipedia.org/wiki/Json for more information on JSON. Please note that all attributes of a method response are not always present. A client application should never assume that a certain attribute is present in a response. # Limits The Pingdom API has usage limits to avoid individual rampant applications degrading the overall user experience. There are two layers of limits, the first cover a shorter period of time and the second a longer period. This enables you to \"burst\" requests for shorter periods. There are two HTTP headers in every response describing your limits status. The response headers are: * **Req-Limit-Short** * **Req-Limit-Long** An example of the values of these headers: * **Req-Limit-Short: Remaining: 394 Time until reset: 3589** * **Req-Limit-Long: Remaining: 71994 Time until reset: 2591989** In this case, we can see that the user has 394 requests left until the short limit is reached. In 3589 seconds, the short limit will be reset. In similar fashion, the long limit has 71994 requests left, and will be reset in 2591989 seconds. If limits are exceeded, an HTTP 429 error code with the message \"Request limit exceeded, try again later\" is sent back. # gzip Responses can be gzip-encoded on demand. This is nice if your bandwidth is limited, or if big results are causing performance issues. To enable gzip, simply add the following header to your request: Accept-Encoding: gzip # Best Practices ## Use caching If you are building a web page using the Pingdom API, we recommend that you do all API request on the server side, and if possible cache them. If you get any substantial traffic, you do not want to call the API each time you get a page hit, since this may cause you to hit the request limit faster than expected. In general, whenever you can cache data, do so. ## Send your user credentials in a preemptive manner Some HTTP clients omit the authentication header, and make a second request with the header when they get a 401 Unauthorized response. Please make sure you send the credentials directly, to avoid unnecessary requests. ## Use common sense Should be simple enough. For example, don't check for the status of a check every other second. The highest check resolution is one minute. Checking more often than that won't give you much of an advantage. ## The Internet is unreliable Networks in general are unreliable, and particularly one as large and complex as the Internet. Your application should not assume it will get an answer. There may be timeouts. # PHP Code Example **\"This is too much to read. I just want to get started right now! Give me a simple example!\"** Here is a short example of how you can use the API with PHP. You need the cURL extension for PHP. The example prints the current status of all your checks. This sample obviously focuses on Pingdom API code and does not worry about any potential problems connecting to the API, but your code should. Code: ```php <?php // Init cURL $curl = curl_init(); // Set target URL curl_setopt($curl, CURLOPT_URL, \"https://api.pingdom.com/api/3.1/checks\"); // Set the desired HTTP method (GET is default, see the documentation for each request) curl_setopt($curl, CURLOPT_CUSTOMREQUEST, \"GET\"); // Add header with Bearer Authorization curl_setopt($curl, CURLOPT_HTTPHEADER, array(\"Authorization: Bearer 907c762e069589c2cd2a229cdae7b8778caa9f07\")); // Ask cURL to return the result as a string curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); // Execute the request and decode the json result into an associative array $response = json_decode(curl_exec($curl), true); // Check for errors returned by the API if (isset($response['error'])) { print \"Error: \" . $response['error']['errormessage'] . \"\\n\"; exit; } // Fetch the list of checks from the response $checksList = $response['checks']; // Print the names and statuses of all checks in the list foreach ($checksList as $check) { print $check['name'] . \" is \" . $check['status'] . \"\\n\"; } ?> ``` Example output: ``` Ubuntu Packages is up Google is up Pingdom is up My server 1 is down My server 2 is up ``` If you are running PHP on Windows, you need to be sure that you have installed the CA certificates for HTTPS/SSL to work correctly. Please see the cURL manual for more information. As a quick (but unsafe) workaround, you can add the following cURL option to ignore certificate validation. ` curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0); ` # TMS Steps Vocabulary There are two types of transaction checks: <ul> <li><b>script</b>: the legacy TMS check created with predefined commands in the Pingdom UI or via the public API</li> <li><b>recording</b>: the TMS check created by recording performed actions in WPM recorder. More information about how to use it can be found in the <a class=\"default-link\" href=\"https://documentation.solarwinds.com/en/success_center/wpm/Content/WPM-Use-the-WPM3-Recorder.htm\"> WPM recorder documentation</a> </li> </ul> ## Script transaction checks ### Commands Actions to be performed for the script TMS check Step Name | \"fn\" | Required \"args\" | Remarks ----------------------------------------- | --------------------- | -------------- | ------- Go to URL | go_to | url | There has to be **exactly one** go_to step Click | click | element | label, name or CSS selector Fill in field | fill | input, value | input: label, name or CSS selector, value: text Check checkbox | check | checkbox | label, name or CSS selector Uncheck checkbox | uncheck | checkbox | label, name or CSS selector Sleep for | sleep | seconds | number (e.g. 0.1) Select radio button | select_radio | radio | name of the radio button Select dropdown | select | select, option | select: label, name or CSS selector, option: content, value or CSS selector Basic auth login with | basic_auth | username, password | username and password as text Submit form | submit | form | name or CSS selector Wait for element | wait_for_element | element | label, name or CSS selector Wait for element to contain | wait_for_contains | element, value | element: label, name or CSS selector, value: text ### Validations Verify the state of the page Step Name | \"fn\" | Required \"args\" | Remarks ----------------------------------------- | --------------------- | -------------- | ------- URL should be | url | url | url to be verified Element should exist | exists | element | label, name or CSS selector Element shouldn't exist | not_exists | element | label, name or CSS selector Element should contain | contains | element, value | element: label, name or CSS selector, value: text Element shouldn't containt | not_contains | element, value | element: label, name or CSS selector, value: text Text field should contain | field_contains | input, value | input: label, name or CSS selector, value: text Text field shouldn't contain | field_not_contains | input, value | input: label, name or CSS selector, value: text Checkbox should be checked | is_checked | checkbox | label, name or CSS selector Checkbox shouldn't be checked | is_not_checked | checkbox | label, name or CSS selector Radio button should be selected | radio_selected | radio | name of the radio button Dropdown with name should be selected | dropdown_selected | select, option | select: label, name or CSS selector, option: content, value or CSS selector Dropdown with name shouldn't be selected | dropdown_not_selected | select, option | select: label, name or CSS selector, option: content, value or CSS selector ### Example steps ``` \"steps\": [ { \"fn\": \"go_to\", \"args\": { \"url\": \"pingdom.com\" } }, { \"fn\": \"click\", \"args\": { \"element\": \"START FREE TRIAL\" } }, { \"fn\": \"url\", \"args\": { \"url\": \"https://www.pingdom.com/sign-up/\" } } ] ``` ## Recording transaction checks Each of check steps contains: <ul> <li><b>fn</b>: function name of the step</li> <li><b>args</b>: function arguments</li> <li><b>guid</b>: automatically generated identifier</li> <li><b>contains_navigate</b>: recorder sets it on true if the step would trigger a page navigation</li> </ul> ### Commands Actions to be performed for the recording TMS check Step Name | \"fn\" | Required \"args\" | Remarks ------------------------- | ------------------------- | ------------------------------- | ------- Go to URL | wpm_go_to | url | Goes to the given url location Click | wpm_click | element, offsetX, offsetY | **element**: label, name or CSS selector,</br> **offsetX/Y**: exact position of a click in the element Click in a exact location | wpm_click_xy | element, x, y, scrollX, scrollY | **element**: label, name or CSS selector,</br> **x/y**: coordinates for the click (in viewport),</br> **scrollX/Y**: scrollbar position Fill | wpm_fill | input, value | **input**: target element,</br> **value**: text to fill the target Move mouse to element | wpm_move_mouse_to_element | element, offsetX, offsetY | **element**: target element,</br> **offsetX/Y**: exact position of the mouse in the element Select dropdown | wpm_select_dropdown | select, option | **select**: target element (drop-down),</br> **option**: text of the option to select Wait | wpm_wait | seconds | **seconds:** numbers of seconds to wait Close tab | wpm_close_tab | - | Closes the latest tab on the tab stack ### Validations Verify the state of the page Step Name | \"fn\" | Required \"args\" | Remarks ---------------------- | ------------------------ | ---------------------------------------------- | ------- Contains text | wpm_contains_timeout | element, value, waitTime, useRegularExpression | **element**: label, name or CSS selector,</br> **value**: text to search for,</br> **waitTime**: time to wait for the value to appear,</br> **useRegularExpression**: use the value as a RegEx Does not contains text | wpm_not_contains_timeout | element, value, waitTime, useRegularExpression | **element**: label, name or CSS selector,</br> **value**: text to search for,</br> **waitTime**: time to wait for the value to appear,</br> **useRegularExpression**: use the value as a RegEx ### Metadata Recording checks contain metadata which is automatically generated by the WPM recorder. Modify with caution!
API version: 3.1
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"bytes"
"context"
"io"
"net/http"
"net/url"
"strings"
)
// SummaryAverageAPIService SummaryAverageAPI service
type SummaryAverageAPIService service
type ApiSummaryAverageCheckidGetRequest struct {
ctx context.Context
ApiService *SummaryAverageAPIService
checkid int32
from *int32
to *int32
probes *string
includeuptime *bool
bycountry *bool
byprobe *bool
}
// Start time of period. Format is UNIX timestamp
func (r ApiSummaryAverageCheckidGetRequest) From(from int32) ApiSummaryAverageCheckidGetRequest {
r.from = &from
return r
}
// End time of period. Format is UNIX timestamp. Default is the current time
func (r ApiSummaryAverageCheckidGetRequest) To(to int32) ApiSummaryAverageCheckidGetRequest {
r.to = &to
return r
}
// Filter to only use results from a list of probes. Format is a comma separated list of probe identifiers. By default result from all probes are shown.
func (r ApiSummaryAverageCheckidGetRequest) Probes(probes string) ApiSummaryAverageCheckidGetRequest {
r.probes = &probes
return r
}
// Include uptime information
func (r ApiSummaryAverageCheckidGetRequest) Includeuptime(includeuptime bool) ApiSummaryAverageCheckidGetRequest {
r.includeuptime = &includeuptime
return r
}
// Split response times into country groups
func (r ApiSummaryAverageCheckidGetRequest) Bycountry(bycountry bool) ApiSummaryAverageCheckidGetRequest {
r.bycountry = &bycountry
return r
}
// Split response times into probe groups
func (r ApiSummaryAverageCheckidGetRequest) Byprobe(byprobe bool) ApiSummaryAverageCheckidGetRequest {
r.byprobe = &byprobe
return r
}
func (r ApiSummaryAverageCheckidGetRequest) Execute() (*SummaryRespAttrs, *http.Response, error) {
return r.ApiService.SummaryAverageCheckidGetExecute(r)
}
/*
SummaryAverageCheckidGet Get the average time/uptime value for a specified
Get the average time / uptime value for a specified check and time period.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param checkid
@return ApiSummaryAverageCheckidGetRequest
*/
func (a *SummaryAverageAPIService) SummaryAverageCheckidGet(ctx context.Context, checkid int32) ApiSummaryAverageCheckidGetRequest {
return ApiSummaryAverageCheckidGetRequest{
ApiService: a,
ctx: ctx,
checkid: checkid,
}
}
// Execute executes the request
// @return SummaryRespAttrs
func (a *SummaryAverageAPIService) SummaryAverageCheckidGetExecute(r ApiSummaryAverageCheckidGetRequest) (*SummaryRespAttrs, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *SummaryRespAttrs
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "SummaryAverageAPIService.SummaryAverageCheckidGet")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/summary.average/{checkid}"
localVarPath = strings.Replace(localVarPath, "{"+"checkid"+"}", url.PathEscape(parameterValueToString(r.checkid, "checkid")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.from != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "from", r.from, "")
} else {
var defaultValue int32 = 0
r.from = &defaultValue
}
if r.to != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "to", r.to, "")
}
if r.probes != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "probes", r.probes, "")
}
if r.includeuptime != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "includeuptime", r.includeuptime, "")
} else {
var defaultValue bool = false
r.includeuptime = &defaultValue
}
if r.bycountry != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "bycountry", r.bycountry, "")
} else {
var defaultValue bool = false
r.bycountry = &defaultValue
}
if r.byprobe != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "byprobe", r.byprobe, "")
} else {
var defaultValue bool = false
r.byprobe = &defaultValue
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}