# Scrapfly Documentation

## Table of Contents

### Dashboard

- [Intro](https://scrapfly.io/docs)
- [Project](https://scrapfly.io/docs/project)
- [Account](https://scrapfly.io/docs/account)
- [Workspace & Team](https://scrapfly.io/docs/workspace-and-team)
- [Billing](https://scrapfly.io/docs/billing)

### Products

#### MCP Server

- [Getting Started](https://scrapfly.io/docs/mcp/getting-started)
- [Tools & API Spec](https://scrapfly.io/docs/mcp/tools)
- [Authentication](https://scrapfly.io/docs/mcp/authentication)
- [Examples & Use Cases](https://scrapfly.io/docs/mcp/examples)
- [FAQ](https://scrapfly.io/docs/mcp/faq)
##### Integrations

- [Overview](https://scrapfly.io/docs/mcp/integrations)
- [Claude Desktop](https://scrapfly.io/docs/mcp/integrations/claude-desktop)
- [Claude Code](https://scrapfly.io/docs/mcp/integrations/claude-code)
- [ChatGPT](https://scrapfly.io/docs/mcp/integrations/chatgpt)
- [Cursor](https://scrapfly.io/docs/mcp/integrations/cursor)
- [Cline](https://scrapfly.io/docs/mcp/integrations/cline)
- [Windsurf](https://scrapfly.io/docs/mcp/integrations/windsurf)
- [Zed](https://scrapfly.io/docs/mcp/integrations/zed)
- [Roo Code](https://scrapfly.io/docs/mcp/integrations/roo-code)
- [VS Code](https://scrapfly.io/docs/mcp/integrations/vscode)
- [LangChain](https://scrapfly.io/docs/mcp/integrations/langchain)
- [LlamaIndex](https://scrapfly.io/docs/mcp/integrations/llamaindex)
- [CrewAI](https://scrapfly.io/docs/mcp/integrations/crewai)
- [OpenAI](https://scrapfly.io/docs/mcp/integrations/openai)
- [n8n](https://scrapfly.io/docs/mcp/integrations/n8n)
- [Make](https://scrapfly.io/docs/mcp/integrations/make)
- [Zapier](https://scrapfly.io/docs/mcp/integrations/zapier)
- [Vapi AI](https://scrapfly.io/docs/mcp/integrations/vapi)
- [Agent Builder](https://scrapfly.io/docs/mcp/integrations/agent-builder)
- [Custom Client](https://scrapfly.io/docs/mcp/integrations/custom-client)


#### Web Scraping API

- [Getting Started](https://scrapfly.io/docs/scrape-api/getting-started)
- [API Specification]()
- [Monitoring](https://scrapfly.io/docs/monitoring)
- [Customize Request](https://scrapfly.io/docs/scrape-api/custom)
- [Debug](https://scrapfly.io/docs/scrape-api/debug)
- [Anti Scraping Protection](https://scrapfly.io/docs/scrape-api/anti-scraping-protection)
- [Proxy](https://scrapfly.io/docs/scrape-api/proxy)
- [Proxy Mode](https://scrapfly.io/docs/scrape-api/proxy-mode)
- [Proxy Mode - Screaming Frog](https://scrapfly.io/docs/scrape-api/proxy-mode/screaming-frog)
- [Proxy Mode - Apify](https://scrapfly.io/docs/scrape-api/proxy-mode/apify)
- [(Auto) Data Extraction](https://scrapfly.io/docs/scrape-api/extraction)
- [Javascript Rendering](https://scrapfly.io/docs/scrape-api/javascript-rendering)
- [Javascript Scenario](https://scrapfly.io/docs/scrape-api/javascript-scenario)
- [SSL](https://scrapfly.io/docs/scrape-api/ssl)
- [DNS](https://scrapfly.io/docs/scrape-api/dns)
- [Cache](https://scrapfly.io/docs/scrape-api/cache)
- [Session](https://scrapfly.io/docs/scrape-api/session)
- [Webhook](https://scrapfly.io/docs/scrape-api/webhook)
- [Screenshot](https://scrapfly.io/docs/scrape-api/screenshot)
- [Errors](https://scrapfly.io/docs/scrape-api/errors)
- [Timeout](https://scrapfly.io/docs/scrape-api/understand-timeout)
- [Throttling](https://scrapfly.io/docs/throttling)
- [Troubleshoot](https://scrapfly.io/docs/scrape-api/troubleshoot)
- [Billing](https://scrapfly.io/docs/scrape-api/billing)
- [FAQ](https://scrapfly.io/docs/scrape-api/faq)

#### Crawler API

- [Getting Started](https://scrapfly.io/docs/crawler-api/getting-started)
- [API Specification]()
- [Retrieving Results](https://scrapfly.io/docs/crawler-api/results)
- [WARC Format](https://scrapfly.io/docs/crawler-api/warc-format)
- [Data Extraction](https://scrapfly.io/docs/crawler-api/extraction-rules)
- [Webhook](https://scrapfly.io/docs/crawler-api/webhook)
- [Billing](https://scrapfly.io/docs/crawler-api/billing)
- [Errors](https://scrapfly.io/docs/crawler-api/errors)
- [Troubleshoot](https://scrapfly.io/docs/crawler-api/troubleshoot)
- [FAQ](https://scrapfly.io/docs/crawler-api/faq)

#### Screenshot API

- [Getting Started](https://scrapfly.io/docs/screenshot-api/getting-started)
- [API Specification]()
- [Accessibility Testing](https://scrapfly.io/docs/screenshot-api/accessibility)
- [Webhook](https://scrapfly.io/docs/screenshot-api/webhook)
- [Billing](https://scrapfly.io/docs/screenshot-api/billing)
- [Errors](https://scrapfly.io/docs/screenshot-api/errors)

#### Extraction API

- [Getting Started](https://scrapfly.io/docs/extraction-api/getting-started)
- [API Specification]()
- [Rules Template](https://scrapfly.io/docs/extraction-api/rules-and-template)
- [LLM Extraction](https://scrapfly.io/docs/extraction-api/llm-prompt)
- [AI Auto Extraction](https://scrapfly.io/docs/extraction-api/automatic-ai)
- [Webhook](https://scrapfly.io/docs/extraction-api/webhook)
- [Billing](https://scrapfly.io/docs/extraction-api/billing)
- [Errors](https://scrapfly.io/docs/extraction-api/errors)
- [FAQ](https://scrapfly.io/docs/extraction-api/faq)

#### Proxy Saver

- [Getting Started](https://scrapfly.io/docs/proxy-saver/getting-started)
- [Fingerprints](https://scrapfly.io/docs/proxy-saver/fingerprints)
- [Optimizations](https://scrapfly.io/docs/proxy-saver/optimizations)
- [SSL Certificates](https://scrapfly.io/docs/proxy-saver/certificates)
- [Protocols](https://scrapfly.io/docs/proxy-saver/protocols)
- [Pacfile](https://scrapfly.io/docs/proxy-saver/pacfile)
- [Secure Credentials](https://scrapfly.io/docs/proxy-saver/security)
- [Billing](https://scrapfly.io/docs/proxy-saver/billing)

#### Cloud Browser API

- [Getting Started](https://scrapfly.io/docs/cloud-browser-api/getting-started)
- [Proxy & Geo-Targeting](https://scrapfly.io/docs/cloud-browser-api/proxy)
- [Unblock API](https://scrapfly.io/docs/cloud-browser-api/unblock)
- [File Downloads](https://scrapfly.io/docs/cloud-browser-api/file-downloads)
- [Session Resume](https://scrapfly.io/docs/cloud-browser-api/session-resume)
- [Human-in-the-Loop](https://scrapfly.io/docs/cloud-browser-api/human-in-the-loop)
- [Debug Mode](https://scrapfly.io/docs/cloud-browser-api/debug-mode)
- [Bring Your Own Proxy](https://scrapfly.io/docs/cloud-browser-api/bring-your-own-proxy)
- [Browser Extensions](https://scrapfly.io/docs/cloud-browser-api/extensions)
- [Native Browser MCP](https://scrapfly.io/docs/cloud-browser-api/mcp)
- [DevTools Protocol](https://scrapfly.io/docs/cloud-browser-api/cdp-reference)
##### Integrations

- [Puppeteer](https://scrapfly.io/docs/cloud-browser-api/puppeteer)
- [Playwright](https://scrapfly.io/docs/cloud-browser-api/playwright)
- [Selenium](https://scrapfly.io/docs/cloud-browser-api/selenium)
- [Vercel Agent Browser](https://scrapfly.io/docs/cloud-browser-api/agent-browser)
- [Browser Use](https://scrapfly.io/docs/cloud-browser-api/browser-use)
- [Stagehand](https://scrapfly.io/docs/cloud-browser-api/stagehand)

- [Billing](https://scrapfly.io/docs/cloud-browser-api/billing)
- [Errors](https://scrapfly.io/docs/cloud-browser-api/errors)


### Tools

- [Antibot Detector](https://scrapfly.io/docs/tools/antibot-detector)

### SDK

- [Golang](https://scrapfly.io/docs/sdk/golang)
- [Python](https://scrapfly.io/docs/sdk/python)
- [Rust](https://scrapfly.io/docs/sdk/rust)
- [TypeScript](https://scrapfly.io/docs/sdk/typescript)
- [Scrapy](https://scrapfly.io/docs/sdk/scrapy)

### Integrations

- [Getting Started](https://scrapfly.io/docs/integration/getting-started)
- [LangChain](https://scrapfly.io/docs/integration/langchain)
- [LlamaIndex](https://scrapfly.io/docs/integration/llamaindex)
- [CrewAI](https://scrapfly.io/docs/integration/crewai)
- [Zapier](https://scrapfly.io/docs/integration/zapier)
- [Make](https://scrapfly.io/docs/integration/make)
- [n8n](https://scrapfly.io/docs/integration/n8n)

### Academy

- [Overview](https://scrapfly.io/academy)
- [Web Scraping Overview](https://scrapfly.io/academy/scraping-overview)
- [Tools](https://scrapfly.io/academy/tools-overview)
- [Reverse Engineering](https://scrapfly.io/academy/reverse-engineering)
- [Static Scraping](https://scrapfly.io/academy/static-scraping)
- [HTML Parsing](https://scrapfly.io/academy/html-parsing)
- [Dynamic Scraping](https://scrapfly.io/academy/dynamic-scraping)
- [Hidden API Scraping](https://scrapfly.io/academy/hidden-api-scraping)
- [Headless Browsers](https://scrapfly.io/academy/headless-browsers)
- [Hidden Web Data](https://scrapfly.io/academy/hidden-web-data)
- [JSON Parsing](https://scrapfly.io/academy/json-parsing)
- [Data Processing](https://scrapfly.io/academy/data-processing)
- [Scaling](https://scrapfly.io/academy/scaling)
- [Walkthrough Summary](https://scrapfly.io/academy/walkthrough-summary)
- [Scraper Blocking](https://scrapfly.io/academy/scraper-blocking)
- [Proxies](https://scrapfly.io/academy/proxies)

---

 1. [DevTools Protocol](https://scrapfly.io/docs/cloud-browser-api/cdp-reference)
2. Tracing
 
  # Tracing

 

**Dependencies:** [IO](https://scrapfly.io/docs/cloud-browser-api/cdp-reference/IO)

 - [Commands (6)](#commands)
- [Events (3)](#events)
- [Types (6)](#types)
 
   

No symbols match your filter.

## Commands

#### `Tracing.end`

 

Stop trace events collection.

 

 

#### `Tracing.getCategories`

 Experimental 

Gets supported tracing categories.

###### Return Object

 | Name | Type | Description |
|---|---|---|
| `categories` | `array<<a href="/docs/cloud-browser-api/cdp-reference/Tracing#type-string">string</a>>` | A list of supported tracing categories. |

 

 

 

#### `Tracing.getTrackEventDescriptor`

 Experimental 

Return a descriptor for all available tracing categories.

###### Return Object

 | Name | Type | Description |
|---|---|---|
| `descriptor` | `binary` | Base64-encoded serialized perfetto.protos.TrackEventDescriptor protobuf message. |

 

 

 

#### `Tracing.recordClockSyncMarker`

 Experimental 

Record a clock sync marker in the trace.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `syncId` | `string` | The ID of this clock sync marker |

 

 

 

#### `Tracing.requestMemoryDump`

 Experimental 

Request a global memory dump.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `deterministic`  (optional) | `boolean` | Enables more deterministic results by forcing garbage collection |
| `levelOfDetail`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/Tracing#type-MemoryDumpLevelOfDetail">MemoryDumpLevelOfDetail</a>` | Specifies level of details in memory dump. Defaults to "detailed". |

 

###### Return Object

 | Name | Type | Description |
|---|---|---|
| `dumpGuid` | `string` | GUID of the resulting global memory dump. |
| `success` | `boolean` | True iff the global memory dump succeeded. |

 

 

 

#### `Tracing.start`

 

Start trace events collection.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `categories`  (optional) Experimental Deprecated | `string` | Category/tag filter |
| `options`  (optional) Experimental Deprecated | `string` | Tracing options |
| `bufferUsageReportingInterval`  (optional) Experimental | `number` | If set, the agent will issue bufferUsage events at this interval, specified in milliseconds |
| `transferMode`  (optional) | `string` | Whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to `ReportEvents`). |
| `streamFormat`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/Tracing#type-StreamFormat">StreamFormat</a>` | Trace data format to use. This only applies when using `ReturnAsStream` transfer mode (defaults to `json`). |
| `streamCompression`  (optional) Experimental | `<a href="/docs/cloud-browser-api/cdp-reference/Tracing#type-StreamCompression">StreamCompression</a>` | Compression format to use. This only applies when using `ReturnAsStream` transfer mode (defaults to `none`) |
| `traceConfig`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/Tracing#type-TraceConfig">TraceConfig</a>` |  |
| `perfettoConfig`  (optional) Experimental | `binary` | Base64-encoded serialized perfetto.protos.TraceConfig protobuf message When specified, the parameters `categories`, `options`, `traceConfig` are ignored. |
| `tracingBackend`  (optional) Experimental | `<a href="/docs/cloud-browser-api/cdp-reference/Tracing#type-TracingBackend">TracingBackend</a>` | Backend type (defaults to `auto`) |

 

 

 

 

## Events

#### `Tracing.bufferUsage`

 Experimental 

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `percentFull`  (optional) | `number` | A number in range \[0..1\] that indicates the used size of event buffer as a fraction of its total size. |
| `eventCount`  (optional) | `number` | An approximate number of events in the trace log. |
| `value`  (optional) | `number` | A number in range \[0..1\] that indicates the used size of event buffer as a fraction of its total size. |

 

 

 

#### `Tracing.dataCollected`

 Experimental 

Contains a bucket of collected trace events. When tracing is stopped collected events will be
sent as a sequence of dataCollected events followed by tracingComplete event.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `value` | `array<<a href="/docs/cloud-browser-api/cdp-reference/Tracing#type-object">object</a>>` |  |

 

 

 

#### `Tracing.tracingComplete`

 

Signals that tracing is stopped and there is no trace buffers pending flush, all data were
delivered via dataCollected events.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `dataLossOccurred` | `boolean` | Indicates whether some trace data is known to have been lost, e.g. because the trace ring buffer wrapped around. |
| `stream`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/IO#type-StreamHandle">IO.StreamHandle</a>` | A handle of the stream that holds resulting trace data. |
| `traceFormat`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/Tracing#type-StreamFormat">StreamFormat</a>` | Trace data format of returned stream. |
| `streamCompression`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/Tracing#type-StreamCompression">StreamCompression</a>` | Compression format of returned stream. |

 

 

 

 

## Types

#### `MemoryDumpConfig`

 (object) Experimental 

Configuration for memory dump. Used only when "memory-infra" category is enabled.

 

 

#### `TraceConfig`

 (object) 

###### Properties

 | Name | Type | Description |
|---|---|---|
| `recordMode`  (optional) Experimental | `string` | Controls how the trace buffer stores data. The default is `recordUntilFull`. |
| `traceBufferSizeInKb`  (optional) Experimental | `number` | Size of the trace buffer in kilobytes. If not specified or zero is passed, a default value of 200 MB would be used. |
| `enableSampling`  (optional) Experimental | `boolean` | Turns on JavaScript stack sampling. |
| `enableSystrace`  (optional) Experimental | `boolean` | Turns on system tracing. |
| `enableArgumentFilter`  (optional) Experimental | `boolean` | Turns on argument filter. |
| `includedCategories`  (optional) | `array<<a href="/docs/cloud-browser-api/cdp-reference/Tracing#type-string">string</a>>` | Included category filters. |
| `excludedCategories`  (optional) | `array<<a href="/docs/cloud-browser-api/cdp-reference/Tracing#type-string">string</a>>` | Excluded category filters. |
| `syntheticDelays`  (optional) Experimental | `array<<a href="/docs/cloud-browser-api/cdp-reference/Tracing#type-string">string</a>>` | Configuration to synthesize the delays in tracing. |
| `memoryDumpConfig`  (optional) Experimental | `<a href="/docs/cloud-browser-api/cdp-reference/Tracing#type-MemoryDumpConfig">MemoryDumpConfig</a>` | Configuration for memory dump triggers. Used only when "memory-infra" category is enabled. |

 

 

 

#### `StreamFormat`

 (string) Experimental 

Data format of a trace. Can be either the legacy JSON format or the
protocol buffer format. Note that the JSON format will be deprecated soon.

###### Allowed Values

- `json`
- `proto`
 
 

 

#### `StreamCompression`

 (string) Experimental 

Compression type to use for traces returned via streams.

###### Allowed Values

- `none`
- `gzip`
 
 

 

#### `MemoryDumpLevelOfDetail`

 (string) Experimental 

Details exposed when memory request explicitly declared.
Keep consistent with memory\_dump\_request\_args.h and
memory\_instrumentation.mojom

###### Allowed Values

- `background`
- `light`
- `detailed`
 
 

 

#### `TracingBackend`

 (string) Experimental 

Backend type to use for tracing. `chrome` uses the Chrome-integrated
tracing service and is supported on all platforms. `system` is only
supported on Chrome OS and uses the Perfetto system tracing service.
`auto` chooses `system` when the perfettoConfig provided to Tracing.start
specifies at least one non-Chrome data source; otherwise uses `chrome`.

###### Allowed Values

- `auto`
- `chrome`
- `system`