Operation Reference

Now that we've covered the basics of how to use Network Capture, the below table provided an in-depth reference to all available parameters and their values, under network_capture object.

ParameterRequiredDescription

method

Optional (default = GET)

String | When provided, what HTTP method should be filtered for. Examples: GET, POST, PUT

validation

Optional (default = false)

Bool | Determine whether to run content validation on the responses or not

url

Optional

Object | Describes the URL(s) to filter and capture.

url.type

optional (default = "exact")

Enum | Can be set to "exact" or "contains".

url.value

required if URL filtering is used*

String | The URL or URL portion to match to.

resource_type

Optional

List [Enums] | set all required resource type to filter.

wait_for_requests_count

Optional (default = 0 )

Integer | Setting the minimum number to be captured. When set, the request duration will be extended to ensure that the requests are captured or until 'wait_for_requests_count_timeout' is reached.

wait_for_requests_count_timeout

Optional (default = 10 seconds)

Integer | Defines the maximum duration an API request can be extended to capture the minimum number of requests specified by 'wait_for_requests_count

Last updated