# 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. Storage # Storage Experimental **Dependencies:** [Browser](https://scrapfly.io/docs/cloud-browser-api/cdp-reference/Browser), [Network](https://scrapfly.io/docs/cloud-browser-api/cdp-reference/Network) - [Commands (40)](#commands) - [Events (15)](#events) - [Types (53)](#types) No symbols match your filter. ## Commands #### `Storage.getStorageKeyForFrame` Deprecated Returns a storage key given a frame id. Deprecated. Please use Storage.getStorageKey instead. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `Page.FrameId` | | ###### Return Object | Name | Type | Description | |---|---|---| | `storageKey` | `SerializedStorageKey` | | #### `Storage.getStorageKey` Experimental Returns storage key for the given frame. If no frame ID is provided, the storage key of the target executing this command is returned. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` (optional) | `Page.FrameId` | | ###### Return Object | Name | Type | Description | |---|---|---| | `storageKey` | `SerializedStorageKey` | | #### `Storage.clearDataForOrigin` Clears storage for origin. ###### Parameters | Name | Type | Description | |---|---|---| | `origin` | `string` | Security origin. | | `storageTypes` | `string` | Comma separated list of StorageType to clear. | #### `Storage.clearDataForStorageKey` Clears storage for storage key. ###### Parameters | Name | Type | Description | |---|---|---| | `storageKey` | `string` | Storage key. | | `storageTypes` | `string` | Comma separated list of StorageType to clear. | #### `Storage.getCookies` Returns all browser cookies. ###### Parameters | Name | Type | Description | |---|---|---| | `browserContextId` (optional) | `Browser.BrowserContextID` | Browser context to use when called on the browser endpoint. | ###### Return Object | Name | Type | Description | |---|---|---| | `cookies` | `array<Network.Cookie>` | Array of cookie objects. | #### `Storage.setCookies` Sets given cookies. ###### Parameters | Name | Type | Description | |---|---|---| | `cookies` | `array<Network.CookieParam>` | Cookies to be set. | | `browserContextId` (optional) | `Browser.BrowserContextID` | Browser context to use when called on the browser endpoint. | #### `Storage.clearCookies` Clears cookies. ###### Parameters | Name | Type | Description | |---|---|---| | `browserContextId` (optional) | `Browser.BrowserContextID` | Browser context to use when called on the browser endpoint. | #### `Storage.getUsageAndQuota` Returns usage and quota in bytes. ###### Parameters | Name | Type | Description | |---|---|---| | `origin` | `string` | Security origin. | ###### Return Object | Name | Type | Description | |---|---|---| | `usage` | `number` | Storage usage (bytes). | | `quota` | `number` | Storage quota (bytes). | | `overrideActive` | `boolean` | Whether or not the origin has an active storage quota override | | `usageBreakdown` | `array<UsageForType>` | Storage usage per type (bytes). | #### `Storage.overrideQuotaForOrigin` Experimental Override quota for the specified origin ###### Parameters | Name | Type | Description | |---|---|---| | `origin` | `string` | Security origin. | | `quotaSize` (optional) | `number` | The quota size (in bytes) to override the original quota with. If this is called multiple times, the overridden quota will be equal to the quotaSize provided in the final call. If this is called without specifying a quotaSize, the quota will be reset to the default value for the specified origin. If this is called multiple times with different origins, the override will be maintained for each origin until it is disabled (called without a quotaSize). | #### `Storage.trackCacheStorageForOrigin` Registers origin to be notified when an update occurs to its cache storage list. ###### Parameters | Name | Type | Description | |---|---|---| | `origin` | `string` | Security origin. | #### `Storage.trackCacheStorageForStorageKey` Registers storage key to be notified when an update occurs to its cache storage list. ###### Parameters | Name | Type | Description | |---|---|---| | `storageKey` | `string` | Storage key. | #### `Storage.trackIndexedDBForOrigin` Registers origin to be notified when an update occurs to its IndexedDB. ###### Parameters | Name | Type | Description | |---|---|---| | `origin` | `string` | Security origin. | #### `Storage.trackIndexedDBForStorageKey` Registers storage key to be notified when an update occurs to its IndexedDB. ###### Parameters | Name | Type | Description | |---|---|---| | `storageKey` | `string` | Storage key. | #### `Storage.untrackCacheStorageForOrigin` Unregisters origin from receiving notifications for cache storage. ###### Parameters | Name | Type | Description | |---|---|---| | `origin` | `string` | Security origin. | #### `Storage.untrackCacheStorageForStorageKey` Unregisters storage key from receiving notifications for cache storage. ###### Parameters | Name | Type | Description | |---|---|---| | `storageKey` | `string` | Storage key. | #### `Storage.untrackIndexedDBForOrigin` Unregisters origin from receiving notifications for IndexedDB. ###### Parameters | Name | Type | Description | |---|---|---| | `origin` | `string` | Security origin. | #### `Storage.untrackIndexedDBForStorageKey` Unregisters storage key from receiving notifications for IndexedDB. ###### Parameters | Name | Type | Description | |---|---|---| | `storageKey` | `string` | Storage key. | #### `Storage.getTrustTokens` Experimental Returns the number of stored Trust Tokens per issuer for the current browsing context. ###### Return Object | Name | Type | Description | |---|---|---| | `tokens` | `array<TrustTokens>` | | #### `Storage.clearTrustTokens` Experimental Removes all Trust Tokens issued by the provided issuerOrigin. Leaves other stored data, including the issuer's Redemption Records, intact. ###### Parameters | Name | Type | Description | |---|---|---| | `issuerOrigin` | `string` | | ###### Return Object | Name | Type | Description | |---|---|---| | `didDeleteTokens` | `boolean` | True if any tokens were deleted, false otherwise. | #### `Storage.exportPrivateTokens` Experimental Exports all private tokens with full data for cross-instance transfer. ###### Return Object | Name | Type | Description | |---|---|---| | `issuers` | `array<PrivateTokenIssuer>` | | | `redemptionRecords` | `array<PrivateTokenRedemptionRecord>` | | | `associations` | `array<PrivateTokenAssociation>` | | | `keyCommitments` | `array<PrivateTokenKeyCommitment>` | | #### `Storage.importPrivateTokens` Experimental Imports private tokens from another instance. Merges with existing state. ###### Parameters | Name | Type | Description | |---|---|---| | `issuers` | `array<PrivateTokenIssuer>` | | | `redemptionRecords` (optional) | `array<PrivateTokenRedemptionRecord>` | | | `associations` (optional) | `array<PrivateTokenAssociation>` | | | `keyCommitments` (optional) | `array<PrivateTokenKeyCommitment>` | | ###### Return Object | Name | Type | Description | |---|---|---| | `success` | `boolean` | | | `errorMessage` (optional) | `string` | | #### `Storage.getInterestGroupDetails` Experimental Gets details for a named interest group. ###### Parameters | Name | Type | Description | |---|---|---| | `ownerOrigin` | `string` | | | `name` | `string` | | ###### Return Object | Name | Type | Description | |---|---|---| | `details` | `object` | This largely corresponds to: https://wicg.github.io/turtledove/#dictdef-generatebidinterestgroup but has absolute expirationTime instead of relative lifetimeMs and also adds joiningOrigin. | #### `Storage.setInterestGroupTracking` Experimental Enables/Disables issuing of interestGroupAccessed events. ###### Parameters | Name | Type | Description | |---|---|---| | `enable` | `boolean` | | #### `Storage.setInterestGroupAuctionTracking` Experimental Enables/Disables issuing of interestGroupAuctionEventOccurred and interestGroupAuctionNetworkRequestCreated. ###### Parameters | Name | Type | Description | |---|---|---| | `enable` | `boolean` | | #### `Storage.getSharedStorageMetadata` Experimental Gets metadata for an origin's shared storage. ###### Parameters | Name | Type | Description | |---|---|---| | `ownerOrigin` | `string` | | ###### Return Object | Name | Type | Description | |---|---|---| | `metadata` | `SharedStorageMetadata` | | #### `Storage.getSharedStorageEntries` Experimental Gets the entries in an given origin's shared storage. ###### Parameters | Name | Type | Description | |---|---|---| | `ownerOrigin` | `string` | | ###### Return Object | Name | Type | Description | |---|---|---| | `entries` | `array<SharedStorageEntry>` | | #### `Storage.setSharedStorageEntry` Experimental Sets entry with `key` and `value` for a given origin's shared storage. ###### Parameters | Name | Type | Description | |---|---|---| | `ownerOrigin` | `string` | | | `key` | `string` | | | `value` | `string` | | | `ignoreIfPresent` (optional) | `boolean` | If `ignoreIfPresent` is included and true, then only sets the entry if `key` doesn't already exist. | #### `Storage.deleteSharedStorageEntry` Experimental Deletes entry for `key` (if it exists) for a given origin's shared storage. ###### Parameters | Name | Type | Description | |---|---|---| | `ownerOrigin` | `string` | | | `key` | `string` | | #### `Storage.clearSharedStorageEntries` Experimental Clears all entries for a given origin's shared storage. ###### Parameters | Name | Type | Description | |---|---|---| | `ownerOrigin` | `string` | | #### `Storage.resetSharedStorageBudget` Experimental Resets the budget for `ownerOrigin` by clearing all budget withdrawals. ###### Parameters | Name | Type | Description | |---|---|---| | `ownerOrigin` | `string` | | #### `Storage.setSharedStorageTracking` Experimental Enables/disables issuing of sharedStorageAccessed events. ###### Parameters | Name | Type | Description | |---|---|---| | `enable` | `boolean` | | #### `Storage.setStorageBucketTracking` Experimental Set tracking for a storage key's buckets. ###### Parameters | Name | Type | Description | |---|---|---| | `storageKey` | `string` | | | `enable` | `boolean` | | #### `Storage.deleteStorageBucket` Experimental Deletes the Storage Bucket with the given storage key and bucket name. ###### Parameters | Name | Type | Description | |---|---|---| | `bucket` | `StorageBucket` | | #### `Storage.runBounceTrackingMitigations` Experimental Deletes state for sites identified as potential bounce trackers, immediately. ###### Return Object | Name | Type | Description | |---|---|---| | `deletedSites` | `array<string>` | | #### `Storage.setAttributionReportingLocalTestingMode` Experimental https://wicg.github.io/attribution-reporting-api/ ###### Parameters | Name | Type | Description | |---|---|---| | `enabled` | `boolean` | If enabled, noise is suppressed and reports are sent immediately. | #### `Storage.setAttributionReportingTracking` Experimental Enables/disables issuing of Attribution Reporting events. ###### Parameters | Name | Type | Description | |---|---|---| | `enable` | `boolean` | | #### `Storage.sendPendingAttributionReports` Experimental Sends all pending Attribution Reports immediately, regardless of their scheduled report time. ###### Return Object | Name | Type | Description | |---|---|---| | `numSent` | `integer` | The number of reports that were sent. | #### `Storage.getRelatedWebsiteSets` Experimental Returns the effective Related Website Sets in use by this profile for the browser session. The effective Related Website Sets will not change during a browser session. ###### Return Object | Name | Type | Description | |---|---|---| | `sets` | `array<RelatedWebsiteSet>` | | #### `Storage.getAffectedUrlsForThirdPartyCookieMetadata` Experimental Returns the list of URLs from a page and its embedded resources that match existing grace period URL pattern rules. https://developers.google.com/privacy-sandbox/cookies/temporary-exceptions/grace-period ###### Parameters | Name | Type | Description | |---|---|---| | `firstPartyUrl` | `string` | The URL of the page currently being visited. | | `thirdPartyUrls` | `array<string>` | The list of embedded resource URLs from the page. | ###### Return Object | Name | Type | Description | |---|---|---| | `matchedUrls` | `array<string>` | Array of matching URLs. If there is a primary pattern match for the first- party URL, only the first-party URL is returned in the array. | #### `Storage.setProtectedAudienceKAnonymity` ###### Parameters | Name | Type | Description | |---|---|---| | `owner` | `string` | | | `name` | `string` | | | `hashes` | `array<binary>` | | ## Events #### `Storage.cacheStorageContentUpdated` A cache's contents have been modified. ###### Parameters | Name | Type | Description | |---|---|---| | `origin` | `string` | Origin to update. | | `storageKey` | `string` | Storage key to update. | | `bucketId` | `string` | Storage bucket to update. | | `cacheName` | `string` | Name of cache in origin. | #### `Storage.cacheStorageListUpdated` A cache has been added/deleted. ###### Parameters | Name | Type | Description | |---|---|---| | `origin` | `string` | Origin to update. | | `storageKey` | `string` | Storage key to update. | | `bucketId` | `string` | Storage bucket to update. | #### `Storage.indexedDBContentUpdated` The origin's IndexedDB object store has been modified. ###### Parameters | Name | Type | Description | |---|---|---| | `origin` | `string` | Origin to update. | | `storageKey` | `string` | Storage key to update. | | `bucketId` | `string` | Storage bucket to update. | | `databaseName` | `string` | Database to update. | | `objectStoreName` | `string` | ObjectStore to update. | #### `Storage.indexedDBListUpdated` The origin's IndexedDB database list has been modified. ###### Parameters | Name | Type | Description | |---|---|---| | `origin` | `string` | Origin to update. | | `storageKey` | `string` | Storage key to update. | | `bucketId` | `string` | Storage bucket to update. | #### `Storage.interestGroupAccessed` One of the interest groups was accessed. Note that these events are global to all targets sharing an interest group store. ###### Parameters | Name | Type | Description | |---|---|---| | `accessTime` | `Network.TimeSinceEpoch` | | | `type` | `InterestGroupAccessType` | | | `ownerOrigin` | `string` | | | `name` | `string` | | | `componentSellerOrigin` (optional) | `string` | For topLevelBid/topLevelAdditionalBid, and when appropriate, win and additionalBidWin | | `bid` (optional) | `number` | For bid or somethingBid event, if done locally and not on a server. | | `bidCurrency` (optional) | `string` | | | `uniqueAuctionId` (optional) | `InterestGroupAuctionId` | For non-global events --- links to interestGroupAuctionEvent | #### `Storage.interestGroupAuctionEventOccurred` An auction involving interest groups is taking place. These events are target-specific. ###### Parameters | Name | Type | Description | |---|---|---| | `eventTime` | `Network.TimeSinceEpoch` | | | `type` | `InterestGroupAuctionEventType` | | | `uniqueAuctionId` | `InterestGroupAuctionId` | | | `parentAuctionId` (optional) | `InterestGroupAuctionId` | Set for child auctions. | | `auctionConfig` (optional) | `object` | Set for started and configResolved | #### `Storage.interestGroupAuctionNetworkRequestCreated` Specifies which auctions a particular network fetch may be related to, and in what role. Note that it is not ordered with respect to Network.requestWillBeSent (but will happen before loadingFinished loadingFailed). ###### Parameters | Name | Type | Description | |---|---|---| | `type` | `InterestGroupAuctionFetchType` | | | `requestId` | `Network.RequestId` | | | `auctions` | `array<InterestGroupAuctionId>` | This is the set of the auctions using the worklet that issued this request. In the case of trusted signals, it's possible that only some of them actually care about the keys being queried. | #### `Storage.sharedStorageAccessed` Shared storage was accessed by the associated page. The following parameters are included in all events. ###### Parameters | Name | Type | Description | |---|---|---| | `accessTime` | `Network.TimeSinceEpoch` | Time of the access. | | `scope` | `SharedStorageAccessScope` | Enum value indicating the access scope. | | `method` | `SharedStorageAccessMethod` | Enum value indicating the Shared Storage API method invoked. | | `mainFrameId` | `Page.FrameId` | DevTools Frame Token for the primary frame tree's root. | | `ownerOrigin` | `string` | Serialization of the origin owning the Shared Storage data. | | `ownerSite` | `string` | Serialization of the site owning the Shared Storage data. | | `params` | `SharedStorageAccessParams` | The sub-parameters wrapped by `params` are all optional and their presence/absence depends on `type`. | #### `Storage.sharedStorageWorkletOperationExecutionFinished` A shared storage run or selectURL operation finished its execution. The following parameters are included in all events. ###### Parameters | Name | Type | Description | |---|---|---| | `finishedTime` | `Network.TimeSinceEpoch` | Time that the operation finished. | | `executionTime` | `integer` | Time, in microseconds, from start of shared storage JS API call until end of operation execution in the worklet. | | `method` | `SharedStorageAccessMethod` | Enum value indicating the Shared Storage API method invoked. | | `operationId` | `string` | ID of the operation call. | | `workletTargetId` | `Target.TargetID` | Hex representation of the DevTools token used as the TargetID for the associated shared storage worklet. | | `mainFrameId` | `Page.FrameId` | DevTools Frame Token for the primary frame tree's root. | | `ownerOrigin` | `string` | Serialization of the origin owning the Shared Storage data. | #### `Storage.storageBucketCreatedOrUpdated` ###### Parameters | Name | Type | Description | |---|---|---| | `bucketInfo` | `StorageBucketInfo` | | #### `Storage.storageBucketDeleted` ###### Parameters | Name | Type | Description | |---|---|---| | `bucketId` | `string` | | #### `Storage.attributionReportingSourceRegistered` Experimental ###### Parameters | Name | Type | Description | |---|---|---| | `registration` | `AttributionReportingSourceRegistration` | | | `result` | `AttributionReportingSourceRegistrationResult` | | #### `Storage.attributionReportingTriggerRegistered` Experimental ###### Parameters | Name | Type | Description | |---|---|---| | `registration` | `AttributionReportingTriggerRegistration` | | | `eventLevel` | `AttributionReportingEventLevelResult` | | | `aggregatable` | `AttributionReportingAggregatableResult` | | #### `Storage.attributionReportingReportSent` Experimental ###### Parameters | Name | Type | Description | |---|---|---| | `url` | `string` | | | `body` | `object` | | | `result` | `AttributionReportingReportResult` | | | `netError` (optional) | `integer` | If result is `sent`, populated with net/HTTP status. | | `netErrorName` (optional) | `string` | | | `httpStatusCode` (optional) | `integer` | | #### `Storage.attributionReportingVerboseDebugReportSent` Experimental ###### Parameters | Name | Type | Description | |---|---|---| | `url` | `string` | | | `body` (optional) | `array<object>` | | | `netError` (optional) | `integer` | | | `netErrorName` (optional) | `string` | | | `httpStatusCode` (optional) | `integer` | | ## Types #### `SerializedStorageKey` (string) #### `StorageType` (string) Enum of possible storage types. ###### Allowed Values - `cookies` - `file_systems` - `indexeddb` - `local_storage` - `shader_cache` - `websql` - `service_workers` - `cache_storage` - `interest_groups` - `shared_storage` - `storage_buckets` - `all` - `other` #### `UsageForType` (object) Usage for a storage type. ###### Properties | Name | Type | Description | |---|---|---| | `storageType` | `StorageType` | Name of storage type. | | `usage` | `number` | Storage usage (bytes). | #### `TrustTokens` (object) Experimental Pair of issuer origin and number of available (signed, but not used) Trust Tokens from that issuer. ###### Properties | Name | Type | Description | |---|---|---| | `issuerOrigin` | `string` | | | `count` | `number` | | #### `InterestGroupAuctionId` (string) Protected audience interest group auction identifier. #### `InterestGroupAccessType` (string) Enum of interest group access types. ###### Allowed Values - `join` - `leave` - `update` - `loaded` - `bid` - `win` - `additionalBid` - `additionalBidWin` - `topLevelBid` - `topLevelAdditionalBid` - `clear` #### `InterestGroupAuctionEventType` (string) Enum of auction events. ###### Allowed Values - `started` - `configResolved` #### `InterestGroupAuctionFetchType` (string) Enum of network fetches auctions can do. ###### Allowed Values - `bidderJs` - `bidderWasm` - `sellerJs` - `bidderTrustedSignals` - `sellerTrustedSignals` #### `SharedStorageAccessScope` (string) Enum of shared storage access scopes. ###### Allowed Values - `window` - `sharedStorageWorklet` - `protectedAudienceWorklet` - `header` #### `SharedStorageAccessMethod` (string) Enum of shared storage access methods. ###### Allowed Values - `addModule` - `createWorklet` - `selectURL` - `run` - `batchUpdate` - `set` - `append` - `delete` - `clear` - `get` - `keys` - `values` - `entries` - `length` - `remainingBudget` #### `SharedStorageEntry` (object) Struct for a single key-value pair in an origin's shared storage. ###### Properties | Name | Type | Description | |---|---|---| | `key` | `string` | | | `value` | `string` | | #### `SharedStorageMetadata` (object) Details for an origin's shared storage. ###### Properties | Name | Type | Description | |---|---|---| | `creationTime` | `Network.TimeSinceEpoch` | Time when the origin's shared storage was last created. | | `length` | `integer` | Number of key-value pairs stored in origin's shared storage. | | `remainingBudget` | `number` | Current amount of bits of entropy remaining in the navigation budget. | | `bytesUsed` | `integer` | Total number of bytes stored as key-value pairs in origin's shared storage. | #### `SharedStoragePrivateAggregationConfig` (object) Represents a dictionary object passed in as privateAggregationConfig to run or selectURL. ###### Properties | Name | Type | Description | |---|---|---| | `aggregationCoordinatorOrigin` (optional) | `string` | The chosen aggregation service deployment. | | `contextId` (optional) | `string` | The context ID provided. | | `filteringIdMaxBytes` | `integer` | Configures the maximum size allowed for filtering IDs. | | `maxContributions` (optional) | `integer` | The limit on the number of contributions in the final report. | #### `SharedStorageReportingMetadata` (object) Pair of reporting metadata details for a candidate URL for `selectURL()`. ###### Properties | Name | Type | Description | |---|---|---| | `eventType` | `string` | | | `reportingUrl` | `string` | | #### `SharedStorageUrlWithMetadata` (object) Bundles a candidate URL with its reporting metadata. ###### Properties | Name | Type | Description | |---|---|---| | `url` | `string` | Spec of candidate URL. | | `reportingMetadata` | `array<SharedStorageReportingMetadata>` | Any associated reporting metadata. | #### `SharedStorageAccessParams` (object) Bundles the parameters for shared storage access events whose presence/absence can vary according to SharedStorageAccessType. ###### Properties | Name | Type | Description | |---|---|---| | `scriptSourceUrl` (optional) | `string` | Spec of the module script URL. Present only for SharedStorageAccessMethods: addModule and createWorklet. | | `dataOrigin` (optional) | `string` | String denoting "context-origin", "script-origin", or a custom origin to be used as the worklet's data origin. Present only for SharedStorageAccessMethod: createWorklet. | | `operationName` (optional) | `string` | Name of the registered operation to be run. Present only for SharedStorageAccessMethods: run and selectURL. | | `operationId` (optional) | `string` | ID of the operation call. Present only for SharedStorageAccessMethods: run and selectURL. | | `keepAlive` (optional) | `boolean` | Whether or not to keep the worket alive for future run or selectURL calls. Present only for SharedStorageAccessMethods: run and selectURL. | | `privateAggregationConfig` (optional) | `SharedStoragePrivateAggregationConfig` | Configures the private aggregation options. Present only for SharedStorageAccessMethods: run and selectURL. | | `serializedData` (optional) | `string` | The operation's serialized data in bytes (converted to a string). Present only for SharedStorageAccessMethods: run and selectURL. TODO(crbug.com/401011862): Consider updating this parameter to binary. | | `urlsWithMetadata` (optional) | `array<SharedStorageUrlWithMetadata>` | Array of candidate URLs' specs, along with any associated metadata. Present only for SharedStorageAccessMethod: selectURL. | | `urnUuid` (optional) | `string` | Spec of the URN:UUID generated for a selectURL call. Present only for SharedStorageAccessMethod: selectURL. | | `key` (optional) | `string` | Key for a specific entry in an origin's shared storage. Present only for SharedStorageAccessMethods: set, append, delete, and get. | | `value` (optional) | `string` | Value for a specific entry in an origin's shared storage. Present only for SharedStorageAccessMethods: set and append. | | `ignoreIfPresent` (optional) | `boolean` | Whether or not to set an entry for a key if that key is already present. Present only for SharedStorageAccessMethod: set. | | `workletOrdinal` (optional) | `integer` | A number denoting the (0-based) order of the worklet's creation relative to all other shared storage worklets created by documents using the current storage partition. Present only for SharedStorageAccessMethods: addModule, createWorklet. | | `workletTargetId` (optional) | `Target.TargetID` | Hex representation of the DevTools token used as the TargetID for the associated shared storage worklet. Present only for SharedStorageAccessMethods: addModule, createWorklet, run, selectURL, and any other SharedStorageAccessMethod when the SharedStorageAccessScope is sharedStorageWorklet. | | `withLock` (optional) | `string` | Name of the lock to be acquired, if present. Optionally present only for SharedStorageAccessMethods: batchUpdate, set, append, delete, and clear. | | `batchUpdateId` (optional) | `string` | If the method has been called as part of a batchUpdate, then this number identifies the batch to which it belongs. Optionally present only for SharedStorageAccessMethods: batchUpdate (required), set, append, delete, and clear. | | `batchSize` (optional) | `integer` | Number of modifier methods sent in batch. Present only for SharedStorageAccessMethod: batchUpdate. | #### `StorageBucketsDurability` (string) ###### Allowed Values - `relaxed` - `strict` #### `StorageBucket` (object) ###### Properties | Name | Type | Description | |---|---|---| | `storageKey` | `SerializedStorageKey` | | | `name` (optional) | `string` | If not specified, it is the default bucket of the storageKey. | #### `StorageBucketInfo` (object) ###### Properties | Name | Type | Description | |---|---|---| | `bucket` | `StorageBucket` | | | `id` | `string` | | | `expiration` | `Network.TimeSinceEpoch` | | | `quota` | `number` | Storage quota (bytes). | | `persistent` | `boolean` | | | `durability` | `StorageBucketsDurability` | | #### `PrivateToken` (object) Experimental A single private token with full data for import/export. ###### Properties | Name | Type | Description | |---|---|---| | `body` | `string` | Base64-encoded token body. | | `signingKey` | `string` | Base64-encoded signing key. | | `creationTime` | `number` | Creation time in seconds since Unix epoch. | #### `PrivateTokenIssuer` (object) Experimental Tokens grouped by issuer origin. ###### Properties | Name | Type | Description | |---|---|---| | `issuerOrigin` | `string` | | | `tokens` | `array<PrivateToken>` | | #### `PrivateTokenRedemptionRecord` (object) Experimental A redemption record for an issuer/top-level pair. ###### Properties | Name | Type | Description | |---|---|---| | `issuerOrigin` | `string` | | | `topLevelOrigin` | `string` | | | `body` | `string` | Base64-encoded RR body. | | `tokenVerificationKey` | `string` | Base64-encoded token verification key. | | `lifetime` | `number` | Lifetime in seconds (0 if unset). | | `creationTime` | `number` | Creation time as seconds since Unix epoch. | | `lastRedemptionTime` | `number` | Last redemption time as seconds since Unix epoch. | #### `PrivateTokenAssociation` (object) Experimental An issuer/top-level association. ###### Properties | Name | Type | Description | |---|---|---| | `issuerOrigin` | `string` | | | `topLevelOrigin` | `string` | | #### `PrivateTokenVerificationKey` (object) Experimental A verification key in a key commitment. ###### Properties | Name | Type | Description | |---|---|---| | `body` | `string` | | | `expiry` | `number` | Expiry time as seconds since Unix epoch. | #### `PrivateTokenKeyCommitment` (object) Experimental Key commitment for an issuer. ###### Properties | Name | Type | Description | |---|---|---| | `issuerOrigin` | `string` | | | `protocolVersion` | `string` | Protocol version (e.g. "TrustTokenV3Pmb", "TrustTokenV3Voprf"). | | `id` | `integer` | | | `batchSize` | `integer` | | | `keys` | `array<PrivateTokenVerificationKey>` | | #### `AttributionReportingSourceType` (string) Experimental ###### Allowed Values - `navigation` - `event` #### `UnsignedInt64AsBase10` (string) Experimental #### `UnsignedInt128AsBase16` (string) Experimental #### `SignedInt64AsBase10` (string) Experimental #### `AttributionReportingFilterDataEntry` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `key` | `string` | | | `values` | `array<string>` | | #### `AttributionReportingFilterConfig` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `filterValues` | `array<AttributionReportingFilterDataEntry>` | | | `lookbackWindow` (optional) | `integer` | duration in seconds | #### `AttributionReportingFilterPair` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `filters` | `array<AttributionReportingFilterConfig>` | | | `notFilters` | `array<AttributionReportingFilterConfig>` | | #### `AttributionReportingAggregationKeysEntry` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `key` | `string` | | | `value` | `UnsignedInt128AsBase16` | | #### `AttributionReportingEventReportWindows` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `start` | `integer` | duration in seconds | | `ends` | `array<integer>` | duration in seconds | #### `AttributionReportingTriggerDataMatching` (string) Experimental ###### Allowed Values - `exact` - `modulus` #### `AttributionReportingAggregatableDebugReportingData` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `keyPiece` | `UnsignedInt128AsBase16` | | | `value` | `number` | number instead of integer because not all uint32 can be represented by int | | `types` | `array<string>` | | #### `AttributionReportingAggregatableDebugReportingConfig` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `budget` (optional) | `number` | number instead of integer because not all uint32 can be represented by int, only present for source registrations | | `keyPiece` | `UnsignedInt128AsBase16` | | | `debugData` | `array<AttributionReportingAggregatableDebugReportingData>` | | | `aggregationCoordinatorOrigin` (optional) | `string` | | #### `AttributionScopesData` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `values` | `array<string>` | | | `limit` | `number` | number instead of integer because not all uint32 can be represented by int | | `maxEventStates` | `number` | | #### `AttributionReportingNamedBudgetDef` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `name` | `string` | | | `budget` | `integer` | | #### `AttributionReportingSourceRegistration` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `time` | `Network.TimeSinceEpoch` | | | `expiry` | `integer` | duration in seconds | | `triggerData` | `array<number>` | number instead of integer because not all uint32 can be represented by int | | `eventReportWindows` | `AttributionReportingEventReportWindows` | | | `aggregatableReportWindow` | `integer` | duration in seconds | | `type` | `AttributionReportingSourceType` | | | `sourceOrigin` | `string` | | | `reportingOrigin` | `string` | | | `destinationSites` | `array<string>` | | | `eventId` | `UnsignedInt64AsBase10` | | | `priority` | `SignedInt64AsBase10` | | | `filterData` | `array<AttributionReportingFilterDataEntry>` | | | `aggregationKeys` | `array<AttributionReportingAggregationKeysEntry>` | | | `debugKey` (optional) | `UnsignedInt64AsBase10` | | | `triggerDataMatching` | `AttributionReportingTriggerDataMatching` | | | `destinationLimitPriority` | `SignedInt64AsBase10` | | | `aggregatableDebugReportingConfig` | `AttributionReportingAggregatableDebugReportingConfig` | | | `scopesData` (optional) | `AttributionScopesData` | | | `maxEventLevelReports` | `integer` | | | `namedBudgets` | `array<AttributionReportingNamedBudgetDef>` | | | `debugReporting` | `boolean` | | | `eventLevelEpsilon` | `number` | | #### `AttributionReportingSourceRegistrationResult` (string) Experimental ###### Allowed Values - `success` - `internalError` - `insufficientSourceCapacity` - `insufficientUniqueDestinationCapacity` - `excessiveReportingOrigins` - `prohibitedByBrowserPolicy` - `successNoised` - `destinationReportingLimitReached` - `destinationGlobalLimitReached` - `destinationBothLimitsReached` - `reportingOriginsPerSiteLimitReached` - `exceedsMaxChannelCapacity` - `exceedsMaxScopesChannelCapacity` - `exceedsMaxTriggerStateCardinality` - `exceedsMaxEventStatesLimit` - `destinationPerDayReportingLimitReached` #### `AttributionReportingSourceRegistrationTimeConfig` (string) Experimental ###### Allowed Values - `include` - `exclude` #### `AttributionReportingAggregatableValueDictEntry` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `key` | `string` | | | `value` | `number` | number instead of integer because not all uint32 can be represented by int | | `filteringId` | `UnsignedInt64AsBase10` | | #### `AttributionReportingAggregatableValueEntry` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `values` | `array<AttributionReportingAggregatableValueDictEntry>` | | | `filters` | `AttributionReportingFilterPair` | | #### `AttributionReportingEventTriggerData` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `data` | `UnsignedInt64AsBase10` | | | `priority` | `SignedInt64AsBase10` | | | `dedupKey` (optional) | `UnsignedInt64AsBase10` | | | `filters` | `AttributionReportingFilterPair` | | #### `AttributionReportingAggregatableTriggerData` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `keyPiece` | `UnsignedInt128AsBase16` | | | `sourceKeys` | `array<string>` | | | `filters` | `AttributionReportingFilterPair` | | #### `AttributionReportingAggregatableDedupKey` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `dedupKey` (optional) | `UnsignedInt64AsBase10` | | | `filters` | `AttributionReportingFilterPair` | | #### `AttributionReportingNamedBudgetCandidate` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `name` (optional) | `string` | | | `filters` | `AttributionReportingFilterPair` | | #### `AttributionReportingTriggerRegistration` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `filters` | `AttributionReportingFilterPair` | | | `debugKey` (optional) | `UnsignedInt64AsBase10` | | | `aggregatableDedupKeys` | `array<AttributionReportingAggregatableDedupKey>` | | | `eventTriggerData` | `array<AttributionReportingEventTriggerData>` | | | `aggregatableTriggerData` | `array<AttributionReportingAggregatableTriggerData>` | | | `aggregatableValues` | `array<AttributionReportingAggregatableValueEntry>` | | | `aggregatableFilteringIdMaxBytes` | `integer` | | | `debugReporting` | `boolean` | | | `aggregationCoordinatorOrigin` (optional) | `string` | | | `sourceRegistrationTimeConfig` | `AttributionReportingSourceRegistrationTimeConfig` | | | `triggerContextId` (optional) | `string` | | | `aggregatableDebugReportingConfig` | `AttributionReportingAggregatableDebugReportingConfig` | | | `scopes` | `array<string>` | | | `namedBudgets` | `array<AttributionReportingNamedBudgetCandidate>` | | #### `AttributionReportingEventLevelResult` (string) Experimental ###### Allowed Values - `success` - `successDroppedLowerPriority` - `internalError` - `noCapacityForAttributionDestination` - `noMatchingSources` - `deduplicated` - `excessiveAttributions` - `priorityTooLow` - `neverAttributedSource` - `excessiveReportingOrigins` - `noMatchingSourceFilterData` - `prohibitedByBrowserPolicy` - `noMatchingConfigurations` - `excessiveReports` - `falselyAttributedSource` - `reportWindowPassed` - `notRegistered` - `reportWindowNotStarted` - `noMatchingTriggerData` #### `AttributionReportingAggregatableResult` (string) Experimental ###### Allowed Values - `success` - `internalError` - `noCapacityForAttributionDestination` - `noMatchingSources` - `excessiveAttributions` - `excessiveReportingOrigins` - `noHistograms` - `insufficientBudget` - `insufficientNamedBudget` - `noMatchingSourceFilterData` - `notRegistered` - `prohibitedByBrowserPolicy` - `deduplicated` - `reportWindowPassed` - `excessiveReports` #### `AttributionReportingReportResult` (string) Experimental ###### Allowed Values - `sent` - `prohibited` - `failedToAssemble` - `expired` #### `RelatedWebsiteSet` (object) Experimental A single Related Website Set object. ###### Properties | Name | Type | Description | |---|---|---| | `primarySites` | `array<string>` | The primary site of this set, along with the ccTLDs if there is any. | | `associatedSites` | `array<string>` | The associated sites of this set, along with the ccTLDs if there is any. | | `serviceSites` | `array<string>` | The service sites of this set, along with the ccTLDs if there is any. |