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.
Parameter | Required | Type | Description |
---|---|---|---|
method | Optional | String | When provided, what HTTP method should be filtered for. Examples: GET, POST, PUT |
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 | Enum/Array | 'document', 'stylesheet', 'image', 'media', 'font', 'script', 'texttrack', 'xhr', 'fetch', 'prefetch', 'eventsource', 'webSocket', 'manifest', 'signedexchange', 'ping', 'cspviolationreport', 'preflight', 'other' |
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' |
While no one field of network_capture
is required, sending at least one field is required.
*If a url
filter is defined, the value
field must be set as well.
Last updated