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.

ParameterRequiredTypeDescription

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'

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