To set up a content check assertion or extract a value to be stored as a variable as part of your multi-step API monitor, you’ll need to specify which value we should look at. The following options are available as sources:
Response body as JSON
Choose this option if the body content of your response contains JSON data, and you want to inspect or capture a certain element in the JSON structure. In the property field for the assertion or variable, specify which JSON element we should inspect.
Examples
Suppose your JSON response has the following content:
{
"access_token":"MjAxNy0xMC0wMlQxMDoxMDoyNy42NDkwOTEzWg==",
"token_type":"Bearer",
"expires_in":86400
}
To capture the value of the access_token attribute, fill in access_token as the property value.
If the object containing the access_token key is the child of another JSON object, specify the complete ‘path’. For example:
{
"response":{
"access_token":"MjAxNy0xMC0wMlQxMDoxMDoyNy42NDkwOTEzWg==",
"token_type":"Bearer",
"expires_in":86400
}
}
Here, the access token can be grabbed by filling in response.access_token as the property value.
Another JSON example: suppose your JSON data contains an array of one or more elements, in this case an array of three products:
[
{
"Name": "Alpha Cygnus IX",
"Price": 20000,
},
{
"Name": "Norcadia Prime",
"Price": 25000,
},
{
"Name": "Risa",
"Price": 37500,
}
]
To get to an attribute of one of those products, we’ll first need to point to one particular element in the array by providing an index. The index of the first element in a JSON array is always zero: [0]. So, to capture the Price attribute of the first product in our array, we would specify [0].Price which results in a value of “20000”.
If your JSON contains an array as the child of another object, you’ll need to specify each ‘step’, including the index for the element in the array. Suppose your JSON contains something similar to:
{
"Destinations":[
{
"Name":"Alpha Cygnus IX",
"Price":20000
},
{
"Name":"Norcadia Prime",
"Price":25000
},
{
"Name":"Risa",
"Price":37500
}
]
}
In this case, the value for the first Name can be captured as Destinations.[0].Name (the value for Name in the first element in the Destinations array), which would yield “Alpha Cygnus IX”.
Response body as XML
If your response contains an XML document, choose this option and specify an XPath query to narrow down which piece of content should be inspected or captured.
Example
Suppose your XML response has the following content:
<AuthInfo>
<access_token>MjAxNy0xMC0wMlQxMDowOTo1My45MDUxNjEyWg==</access_token>
<expires_in>86400</expires_in>
<token_type>Bearer</token_type>
</AuthInfo>
To capture the inner value of the access_token node, use the XPath query /AuthInfo/access_token/text() as the property value.
For more information, please look at more XPath examples, including SOAP XML.
If the response body cannot be parsed as a standalone XML document, if the XPath query is invalid or does not select an actual value from the document, an error will be generated.
Response body as text
If your response content is not JSON or XML (e.g. plain text, HTML or a proprietary format) you can still use this option to search that content. By default, we’ll consider the entire content of the response. This works fine if you only want to perform a simple Contains-operation (for example: the response body must contain the phrase “Price”; that check will be satisfied as long as the word Price appears somewhere in the content). To use the entire content for your assertion or variable definition, leave the property field empty.
However, if you’re looking to inspect or extract content from a very specific location in the document, you’ll need a way to define which part of the content we should use for that. To do this, specify a regular expression in the property field. Using the pattern matching capabilities of regular expressions, we’ll try to match the regex and use the first match to capture that value from your content.
If the regular expression contains a so-called capturing group (which allows you to define an inner pattern inside the regular expression), we’ll use the first match for that capturing group.
Please note that these options apply to text content only (although it may be applied to responses containing JSON or XML as well, since those are still just text); searching binary content is not supported.
Status code
This option inspects the numeric HTTP status code that is part of every HTTP response. In most cases, you’ll just want to check that the status is 200 (which means OK), or at least does not represent a failure. In fact, we’ll do this for you by default: if you don’t specify a Status code assertion, we will automatically perform the following assertion, since 4xx and 5xx codes are generally error codes:
Status code Is less than 400
However, if you define a Status code assertion yourself, it will overrule our default check. For example, if you define
Status code Is equal to 200
we will check exactly that condition.
Status description
This option looks at the textual description of the HTTP status code (formally called the Reason-Phrase). This can be useful when you’re checking the behavior of certain error conditions in your API: you may want to verify that when you feed incorrect input into your API, a useful Status description is returned.
Response completed
This option always returns a Boolean value related to whether the HTTP request could be completed successfully. It returns false if we could not determine which server to connect to, if no connection could be established, or if the server did not respond with an HTTP response in a timely fashion. In all other cases, it returns true.
You won’t need to specify this option for most cases, because we’ll check it for you automatically: based on this assertion type, we will report an error whenever we cannot retrieve an HTTP response from your server:
Response completed Is equal to true
For some special cases, it is possible to turn this check around: if you specify false instead, we will check that getting a successful response is NOT possible. This may be useful if you have a web application or API that should only be available inside your network, even though the corresponding domain name is publicly available. Using this check, we will verify that we cannot reach your API or web app.
Response header
This option allows you to inspect a specific HTTP response header. You must specify the name of that header in the property field.
Cookie
This option returns the current value of a cookie. You must specify the name of that cookie in the property field. Please note that cookies returned by your server are treated as session cookies: cookie values are retained, updated and sent back to your server during execution of the entire scenario, up until the last step. Afterwards, all cookies are removed, regardless of any expiration directives. This means that permanent cookies are essentially treated as session cookies.
Content length
This option returns the size (in bytes) of the response body. Please note that this is the actual content length after the response body has been decompressed (if your server previously compressed it).
Duration
This option returns the total amount of time (in milliseconds) it took to execute the request and receive the response. This allows you to monitor performance times for individual steps.