You need a Snapshot ID to use this endpoint. A Snapshot ID (e.g., snap_m2bxug4e2o352v1jv1) is a unique identifier created each time a data collection is triggered or a dataset is filtered.
If you don’t have a Snapshot ID yet, start by filtering a dataset Filter Dataset or triggering a collection first. The response will include the snapshot_id you need.
A snapshot can be delivered only while it is within the retention period.Dataset snapshots are available for 14 days after they are generated. After this period, the snapshot expires and can no longer be delivered.To deliver the data after expiration, create a new snapshot for the same dataset.
Authorizations
Authorization
string
header
required
Use your Bright Data API Key as a Bearer token in the Authorization header.
Number of records per file. Use this to split large snapshots into multiple smaller files. Files are split by record count. Recommended for snapshots with more than 1 million records. Note: Maximum batch size is 5GB.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Bright Data Docs","description":"Documentation for Bright Data proxies, Web Unlocker API, SERP API, Web Scraper API, Browser API, Bright Data MCP, datasets and the CLI.","colors":{"primary":"#4180f9","light":"#4180f9","dark":"#4180f9"},"logo":{"light":"https://mintcdn.com/brightdata/FreEYbEGZchU-2Iw/logo/light.svg?fit=max\u0026auto=format\u0026n=FreEYbEGZchU-2Iw\u0026q=85\u0026s=fa5461a75d0b4cf2e744c89d4b67afac","dark":"https://mintcdn.com/brightdata/FreEYbEGZchU-2Iw/logo/dark.svg?fit=max\u0026auto=format\u0026n=FreEYbEGZchU-2Iw\u0026q=85\u0026s=43d5b51e1516be57edb429337abdc90f","href":"https://brightdata.com/"},"favicon":"https://mintcdn.com/brightdata/5sJgYq9iW-Vo_7rr/favicon.svg?fit=max\u0026auto=format\u0026n=5sJgYq9iW-Vo_7rr\u0026q=85\u0026s=1b96b56f36033019c22871f4799240b0","api":{"mdx":{"auth":{"method":"bearer","name":"API_KEY"}}},"navbar":{"links":[{"href":"https://help.brightdata.com/hc/en-us/requests/new","label":"Support"}],"primary":{"type":"button","label":"Sign up","href":"https://brightdata.com/?hs_signup=1\u0026utm_source=docs"}},"footer":{"socials":{"linkedin":"https://il.linkedin.com/company/bright-data","youtube":"https://www.youtube.com/channel/UCM_0cG1ljAoEUcZIyoUIq6g","github":"https://github.com/luminati-io"}},"styling":{"eyebrows":"section","latex":true},"integrations":{"ga4":{"measurementId":"G-20NKMKN19K"},"gtm":{"tagId":"GTM-P69HL92P"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"navigation":{"languages":[{"language":"en","href":"introduction"},{"language":"cn","href":"cn/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"brightdata","hasAudioNarration":false,"actualSubdomain":"brightdata","customDomains":["docs.brightdata.com"],"gitSource":{"type":"github","owner":"luminati-io","repo":"webdocs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":false,"issues":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aff01e11c16aa85135ee23c","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"en","tag":"Data extraction","count":354},{"language":"cn","tag":"数据提取","count":354},{"language":"en","tag":"API reference","count":340},{"language":"cn","tag":"API 参考","count":339},{"language":"en","tag":"Documentation","count":206},{"language":"cn","tag":"文档","count":206},{"language":"en","tag":"Scraper API","count":157},{"language":"cn","tag":"Scraper API","count":157},{"language":"en","tag":"Integrations","count":110},{"language":"cn","tag":"集成","count":110},{"language":"en","tag":"SERP API","count":96},{"language":"cn","tag":"SERP API","count":96},{"language":"en","tag":"Social Media APIs","count":66},{"language":"cn","tag":"社交媒体 API","count":66},{"language":"cn","tag":"管理 API","count":64},{"language":"en","tag":"Administrative APIs","count":51},{"language":"en","tag":"Account Management API","count":51},{"language":"cn","tag":"账号管理 API","count":51},{"language":"cn","tag":"代理网络","count":47},{"language":"en","tag":"Proxy","count":46}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"api-reference/style.css","content":".scrollable-list{max-height:150px;overflow-y:auto;border:1px solid #ccc;padding:10px;width:200px;margin:20px}.scrollable-list ul{padding:0;margin:0}.scrollable-list li{transition:transform 0.3s ease, background-color 0.3s ease;padding:5px;margin:4px 0;background-color:#f5f5f5;list-style:none}.scrollable-list li:hover{transform:translateX(10px);background-color:#e0f7fa}"},{"filePath":"style.css","content":"footer{margin-top:2rem}div:has(>div.flex.flex-row-reverse>div.relative.grow>div.mdx-content>.bd-landing){max-width:none!important}div.mdx-content:has(>.bd-landing),div.prose:has(>.bd-landing){max-width:none!important;width:100%!important}div:has(>div.mdx-content>.bd-landing)>header.relative.leading-none,div:has(>div.mdx-content>.bd-landing)>header{display:none!important}.bd-landing{width:100%;max-width:100%}.bd-landing{--bd-primary: #4180f9;--bd-primary-tint: rgba(65, 128, 249, 0.08);--bd-primary-border: rgba(65, 128, 249, 0.25)}.bd-page{width:100%;max-width:100%;margin:0 auto;padding:0 0 3rem;box-sizing:border-box}.bd-hero{display:grid;grid-template-columns:1fr;gap:2rem;align-items:start;margin:0.5rem 0 1.25rem}@media (min-width: 960px){.bd-hero{grid-template-columns:minmax(0, 1.1fr) minmax(0, 1fr);gap:3rem}}.bd-hero-copy{min-width:0}.bd-hero-image{min-width:0;max-width:100%;display:flex;align-items:center;justify-content:center}.bd-hero-image img{width:100%;max-width:480px;max-height:360px;height:auto;object-fit:contain;display:block}.bd-eyebrow{display:inline-block;font-size:0.75rem;font-weight:600;color:var(--bd-primary);text-transform:uppercase;letter-spacing:0.08em;margin-bottom:0.75rem}.bd-hero-copy .bd-headline,h1.bd-headline{font-size:2.75rem!important;font-weight:800!important;line-height:1.05!important;margin:0 0 1rem!important;letter-spacing:-0.025em!important;display:block!important;text-wrap:balance}.bd-hero-copy .bd-headline>a,.bd-hero-copy .bd-headline::before{display:none!important}.bd-subhead{font-size:1.125rem;line-height:1.6;color:#475569;margin:0 0 1.5rem;max-width:38rem}.dark .bd-subhead{color:#cbd5e1}.bd-cta-row{display:flex;flex-wrap:wrap;gap:0.75rem;margin:1.25rem 0 0}.bd-cta-row a.bd-cta-primary,.bd-cta-row a.bd-cta-secondary{display:inline-flex;align-items:center;gap:0.5rem;padding:0.75rem 1.25rem;border-radius:8px;font-size:0.9375rem;font-weight:600;text-decoration:none!important;transition:all 0.15s ease}.bd-cta-row a.bd-cta-primary{background:var(--bd-primary);color:#fff!important;border:1px solid var(--bd-primary)}.bd-cta-row a.bd-cta-primary:hover{background:#2f6ce8;transform:translateY(-1px);box-shadow:0 6px 16px rgba(65, 128, 249, 0.25)}.bd-cta-row a.bd-cta-secondary{background:transparent;color:var(--bd-primary)!important;border:1px solid var(--bd-primary-border)}.bd-cta-row a.bd-cta-secondary:hover{background:var(--bd-primary-tint);border-color:var(--bd-primary)}.bd-callout{display:flex;align-items:center;gap:0.75rem;padding:0.875rem 1.25rem;margin:0 0 2rem;background:var(--bd-primary-tint);border:1px solid var(--bd-primary-border);border-radius:10px;font-size:0.9375rem;line-height:1.5}.bd-callout a{color:var(--bd-primary)!important;font-weight:600;text-decoration:underline}.bd-callout-icon{flex:0 0 auto;font-size:1rem;line-height:1}.bd-pill{display:inline-block;padding:0.25rem 0.625rem;background:var(--bd-primary);color:#fff;border-radius:999px;font-size:0.6875rem;font-weight:700;text-transform:uppercase;letter-spacing:0.06em;vertical-align:middle}.bd-group-label{margin-top:0.5rem;margin-bottom:1rem}h3.bd-group-heading,.bd-page h3.bd-group-heading{font-size:0.8125rem!important;font-weight:700!important;text-transform:uppercase;letter-spacing:0.08em;color:#64748b!important;margin-top:2.5rem!important;margin-bottom:1rem!important;padding-left:0!important}.dark h3.bd-group-heading,.dark .bd-page h3.bd-group-heading{color:#94a3b8!important}h3.bd-group-heading::before,.bd-page h3.bd-group-heading::before{display:none!important;content:none!important}.bd-landing a[href]:has(>div),.bd-landing [class*=\"card\"]{transition:all 0.2s ease!important}.bd-landing a[href]:has(>div):hover,.bd-landing [class*=\"card\"]:hover{border-color:var(--bd-primary)!important;transform:translateY(-2px)!important;box-shadow:0 8px 24px rgba(65, 128, 249, 0.12)!important}.bd-landing svg[class*=\"icon\"],.bd-landing [class*=\"card\"] svg{color:var(--bd-primary)!important}.bd-page>h2{font-size:1.75rem!important;font-weight:700!important;margin-top:4rem!important;margin-bottom:1.25rem!important;line-height:1.2!important;position:relative;padding-left:1rem;color:inherit}.bd-page>h2::before{content:\"\";position:absolute;left:0;top:0.25rem;bottom:0.25rem;width:4px;background:var(--bd-primary);border-radius:2px}.bd-page>h2+p,.bd-page>h3+p{margin-top:0!important;margin-bottom:1.5rem!important;color:#64748b;font-size:1rem;line-height:1.6}.dark .bd-page>h2+p,.dark .bd-page>h3+p{color:#94a3b8}.bd-page>h3{font-size:1.125rem!important;font-weight:600!important;margin-top:2rem!important;margin-bottom:1rem!important;color:inherit}.bd-page>p{font-size:1rem;line-height:1.6;color:inherit;margin:0 0 1.5rem}div.mt-12>li>div{font-weight:600}div.mt-12>h5{font-weight:bolder}.bd-browse-all{display:inline-flex;align-items:center;gap:0.375rem;margin-top:1.25rem;margin-bottom:2rem;font-weight:600;color:var(--bd-primary)!important}.bd-credits{margin:1.5rem 0 0;font-size:0.875rem;line-height:1.6;color:#64748b}.dark .bd-credits{color:#94a3b8}.bd-hero-code{min-width:0;max-width:100%}.bd-hero-code pre{font-size:0.8125rem}.bd-hero{margin-bottom:3rem}.bd-page--plain>h2{padding-left:0!important}.bd-page--plain>h2::before{display:none!important;content:none!important}.bd-landing p.truncate{white-space:normal!important;overflow:visible!important;text-overflow:clip!important}.bd-landing a.tile,.bd-landing a.tile>div{align-items:flex-start!important;justify-content:flex-start!important;text-align:left!important}.bd-landing a.tile img{width:100%!important;align-self:stretch!important}.bd-catalog-row{display:grid;grid-template-columns:minmax(0, 1fr) minmax(0, 2fr);gap:2rem 3rem;padding:2.25rem 0}.bd-catalog-row+.bd-catalog-row{border-top:1px solid rgba(148, 163, 184, 0.18)}@media (max-width: 860px){.bd-catalog-row{grid-template-columns:1fr;gap:1rem}}.bd-catalog-info h3{font-size:1.1875rem!important;font-weight:600!important;margin:0 0 0.5rem!important}.bd-catalog-info h3 a,.bd-catalog-info h3::before{display:none!important}.bd-catalog-info p{margin:0;font-size:0.9375rem;line-height:1.6;color:#64748b;max-width:26rem}.dark .bd-catalog-info p{color:#94a3b8}.bd-catalog-items{display:grid;grid-template-columns:repeat(auto-fill, minmax(12.5rem, 1fr));gap:0.25rem 1rem;align-content:start}a.bd-catalog-item{display:flex;align-items:flex-start;gap:0.625rem;padding:0.5rem 0.625rem;border-radius:8px;font-size:0.9375rem;font-weight:500;color:inherit!important;text-decoration:none!important;border:none!important;transition:background 0.15s ease}a.bd-catalog-item:hover{background:rgba(65, 128, 249, 0.08)}a.bd-catalog-item:hover .bd-catalog-item-name{color:var(--bd-primary, #4180f9)}.bd-catalog-item-text{display:flex;flex-direction:column;gap:0.125rem;min-width:0}.bd-catalog-item-name{line-height:1.35}.bd-catalog-item-desc{font-size:0.8125rem;font-weight:400;line-height:1.45;color:#64748b}.dark .bd-catalog-item-desc{color:#94a3b8}a.bd-catalog-item svg{margin-top:0.2rem}a.bd-catalog-item svg,a.bd-catalog-item [class*=\"icon\"]{flex:0 0 auto;width:1rem;height:1rem;color:var(--bd-primary, #4180f9)}.bd-footer-links{display:flex;flex-wrap:wrap;gap:2rem;margin-top:5rem;padding-top:1.75rem;border-top:1px solid rgba(148, 163, 184, 0.25)}.bd-footer-links a{font-size:0.875rem;font-weight:500;color:#64748b!important;text-decoration:none!important}.bd-footer-links a:hover{color:var(--bd-primary)!important}.dark .bd-footer-links a{color:#94a3b8!important}.scrollable-list{max-height:150px;overflow-y:auto;border:1px solid #ccc;padding:10px;width:200px;margin:20px}.scrollable-list ul{padding:0;margin:0}.scrollable-list li{transition:transform 0.3s ease, background-color 0.3s ease;padding:5px;margin:4px 0;background-color:#f5f5f5;list-style:none}.scrollable-list li:hover{transform:translateX(10px);background-color:#e0f7fa}"}]}
{"page":{"pagePath":"api-reference/marketplace-dataset-api/deliver-snapshot","slug":"/api-reference/marketplace-dataset-api/deliver-snapshot","pageMetadata":{"title":"Deliver snapshot","description":"Use the Bright Data Marketplace Dataset API to deliver a Snapshot. POST /datasets/snapshots/{id}/deliver returns 200 OK with metadata as JSON.","openapi":"api-reference/dca-api POST /datasets/snapshots/{id}/deliver","href":"/api-reference/marketplace-dataset-api/deliver-snapshot"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Use the Bright Data Marketplace Dataset API to deliver a Snapshot. POST /datasets/snapshots/\", \"/deliver returns 200 OK with metadata as JSON.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,blockquote:`blockquote`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,CodeBlock,CodeGroup,Heading,Step,Steps,Table,Tip}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(AccordionGroup,{children:[_jsxs(Accordion,{title:`Before you begin`,icon:`circle-info`,iconType:`duotone`,id:`before-you-begin`,children:[_jsxs(_components.p,{children:[`You need a `,_jsx(_components.strong,{children:`Snapshot ID`}),` to use this endpoint. A Snapshot ID (e.g., `,_jsx(_components.code,{children:`snap_m2bxug4e2o352v1jv1`}),`) is a unique identifier created each time a data collection is triggered or a dataset is filtered.`]}),_jsx(Heading,{level:`3`,id:`where-do-snapshot-ids-come-from%3F`,children:`Where do Snapshot IDs come from?`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Source`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Endpoint`}),_jsx(_components.th,{style:{textAlign:`left`},children:`What it returns`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.a,{href:`/api-reference/marketplace-dataset-api/filter-dataset`,children:`Filter Dataset`})}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.code,{children:`POST`}),` `,_jsx(_components.code,{children:`/datasets/filter`})]}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.code,{children:`snapshot_id`}),` in the response body`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.a,{href:`/api-reference/rest-api/scraper/asynchronous-requests`,children:`Trigger Collection`})}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.code,{children:`POST`}),` `,_jsx(_components.code,{children:`/datasets/v3/trigger`})]}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.code,{children:`snapshot_id`}),` in the response body`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`Dataset Subscription`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Automatic delivery schedule`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Snapshot IDs are generated per scheduled run`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.a,{href:`/api-reference/scrapers/management-apis/get-snapshots`,children:`Snapshot List`})}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.code,{children:`GET`}),` `,_jsx(_components.code,{children:`/datasets/v3/snapshots`})]}),_jsx(_components.td,{style:{textAlign:`left`},children:`List of all snapshots with their IDs`})]})]})]}),_jsx(Tip,{children:_jsxs(_components.p,{children:[`If you don’t have a Snapshot ID yet, start by filtering a dataset `,_jsx(_components.a,{href:`/api-reference/marketplace-dataset-api/filter-dataset`,children:`Filter Dataset`}),` or `,_jsx(_components.a,{href:`/api-reference/rest-api/scraper/asynchronous-requests`,children:`triggering a collection`}),` first. The response will include the `,_jsx(_components.code,{children:`snapshot_id`}),` you need.`]})}),_jsx(_components.p,{children:`You can check snapshot status before delivering:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.brightdata.com/datasets/snapshots/snap_m2bxug4e2o352v1jv1\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_API_KEY\"`})]}),`\n`]})})}),_jsxs(_components.p,{children:[`The snapshot must be in `,_jsx(_components.code,{children:`ready`}),` status before delivery.`]}),_jsxs(_components.blockquote,{children:[`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/api-reference/marketplace-dataset-api/get-snapshot-meta`,children:`Get Snapshot Metadata`}),` for full documentation.`]}),`\n`]})]}),_jsxs(Accordion,{title:`Tracking delivery status`,icon:`clock`,iconType:`duotone`,id:`tracking-delivery-status`,children:[_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`id`}),` returned in the response is a `,_jsx(_components.strong,{children:`delivery job ID`}),`. Use it to monitor whether your delivery has completed, failed, or been canceled.`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Endpoint`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`GET`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.brightdata.com/datasets/v3/delivery/{delivery_id}`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Example`,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.brightdata.com/datasets/v3/delivery/del_abc123xyz\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_API_KEY\"`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Response`,numberOfLines:`10`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`10`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"del_abc123xyz\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"done\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"delivery_files\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"filename\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"my-data.json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"delivery_ts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1709000000`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`id`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`The delivery job ID`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`status`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Delivery status: done, canceled, or failed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`delivery_files`})}),_jsx(_components.td,{children:`array`}),_jsx(_components.td,{children:`List of delivered files with filename and delivery timestamp`})]})]})]}),_jsx(Tip,{children:_jsxs(_components.p,{children:[`Poll this endpoint until status is “done”. For large snapshots with `,_jsx(_components.code,{children:`batch_size`}),` set, `,_jsx(_components.code,{children:`delivery_files`}),` will contain multiple entries, one per batch file.`]})}),_jsxs(_components.blockquote,{children:[`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/api-reference/scrapers/management-apis/monitor-delivery`,children:`Monitor Delivery`}),` for full documentation.`]}),`\n`]})]}),_jsxs(Accordion,{title:`End-to-end workflow`,icon:`arrows-left-right`,iconType:`duotone`,id:`end-to-end-workflow`,children:[_jsx(_components.p,{children:`Here’s the complete flow from triggering a collection to receiving your data:`}),_jsxs(Steps,{children:[_jsxs(Step,{title:`Trigger a collection or filter a dataset`,children:[_jsxs(_components.p,{children:[`This creates a snapshot and returns a `,_jsx(_components.code,{children:`snapshot_id`}),`.`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Request`,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.brightdata.com/datasets/v3/trigger?dataset_id=gd_l1viktl72bvl7bjuj0\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '[{\"url\": \"https://example.com/product/123\"}]'`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`{\"snapshot_id\": \"snap_m2bxug4e2o352v1jv1\"}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})]}),_jsxs(Step,{title:`Wait for the snapshot to be ready`,children:[_jsx(_components.p,{children:`Poll the snapshot metadata endpoint until status is “ready”.`}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Request`,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.brightdata.com/datasets/snapshots/snap_m2bxug4e2o352v1jv1\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_API_KEY\"`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Response`,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ready\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"dataset_size\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`50000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"file_size\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`250000000`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})]}),_jsxs(Step,{title:`Deliver the snapshot`,children:[_jsx(_components.p,{children:`Call this endpoint with the snapshot ID and your delivery configuration.`}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Request`,numberOfLines:`10`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`10`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.brightdata.com/datasets/snapshots/snap_m2bxug4e2o352v1jv1/deliver\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"deliver\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\": \"webhook\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"filename\": {\"template\": \"my-data\", \"extension\": \"json\"},`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"endpoint\": \"https://example.com/webhook\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Response`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"del_abc123xyz\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})]}),_jsxs(Step,{title:`Track the delivery`,children:[_jsx(_components.p,{children:`Use the delivery job ID to monitor progress.`}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Request`,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.brightdata.com/datasets/v3/delivery/del_abc123xyz\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_API_KEY\"`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Response`,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"del_abc123xyz\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"done\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"delivery_files\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`...`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`snapshot-retention`,children:`Snapshot retention`}),`\n`,_jsx(_components.p,{children:`A snapshot can be delivered only while it is within the retention period.`}),`\n`,_jsx(_components.p,{children:`Dataset snapshots are available for 14 days after they are generated. After this period, the snapshot expires and can no longer be delivered.`}),`\n`,_jsx(_components.p,{children:`To deliver the data after expiration, create a new snapshot for the same dataset.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Deliver snapshot","description":"Use the Bright Data Marketplace Dataset API to deliver a Snapshot. POST /datasets/snapshots/{id}/deliver returns 200 OK with metadata as JSON.","openapi":"api-reference/dca-api POST /datasets/snapshots/{id}/deliver","href":"/api-reference/marketplace-dataset-api/deliver-snapshot"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Snapshot retention","slug":"snapshot-retention","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/brightdata/68bae243aeababfe/script.js","/_mintlify/custom/brightdata/c119bb67904233e1/nav-internal-links.js","/_mintlify/custom/brightdata/2dd0be8455e09562/prompt-copy-plaintext.js","/_mintlify/custom/brightdata/614f9419dc2a8785/marketing-attribution.js"],"openApiReferenceData":{"operation":{"operationId":"deliverDatasetSnapshot","description":"Use the Bright Data Marketplace Dataset API to deliver a Snapshot. POST /datasets/snapshots/{id}/deliver returns 200 OK with metadata as JSON.","parameters":["b4bf9135-7e11-467e-a352-2019bdf7505d"],"requestBody":"be5fa61e-c73e-4741-bff5-ba2db8f1f317","responses":{"200":"fa9ca4bf-3fd2-4118-9f72-ea9889eac302","400":"23cd833b-9070-474a-b535-ed850ee717d9","404":"8a7eb602-a5cb-4389-a1fb-289d32f6bfb0"},"method":"post","type":"path","servers":["5fec9d8b-5423-468e-8516-c22c4945afdb"],"security":["3572c80a-5226-415b-a727-65415715e451"],"path":"/datasets/snapshots/{id}/deliver","baseUrlOptions":["https://api.brightdata.com"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b4bf9135-7e11-467e-a352-2019bdf7505d":{"in":"path","name":"id","description":"The Snapshot ID to deliver. This is the unique identifier returned when you trigger a collection, filter a dataset, or run a subscription. \n\n> Learn more about [Snapshot ID](/api-reference/terminology#snapshot-id).","required":true,"schema":{"type":"string","example":"snap_m2bxug4e2o352v1jv1","isRequired":true,"description":"The Snapshot ID to deliver. This is the unique identifier returned when you trigger a collection, filter a dataset, or run a subscription. \n\n> Learn more about [Snapshot ID](/api-reference/terminology#snapshot-id).","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"deliver":{"oneOf":[{"type":"object","title":"Microsoft Azure","description":"Deliver configuration","required":["container","credentials","type","filename"],"properties":{"type":{"type":"string","description":"Type of the delivery target","enum":["azure"],"isRequired":true,"uniqueKey":"deliver.oneOf.0.type","typeLabel":"enum\u003cstring>"},"filename":{"type":"object","additionalProperties":false,"properties":{"template":{"type":"string","description":"Template for the filename, including placeholders.","isRequired":true,"uniqueKey":"deliver.oneOf.0.filename.template","typeLabel":"string"},"extension":{"type":"string","enum":["json","csv","xlsx","ndjson","parquet","jsonl"],"isRequired":true,"uniqueKey":"deliver.oneOf.0.filename.extension","typeLabel":"enum\u003cstring>"}},"required":["template","extension"],"isRequired":true,"uniqueKey":"deliver.oneOf.0.filename","typeLabel":"object"},"container":{"type":"string","minLength":3,"pattern":"^[a-z0-9](-?[a-z0-9])*$","isRequired":true,"uniqueKey":"deliver.oneOf.0.container","typeLabel":"string"},"credentials":{"oneOf":[{"type":"object","title":"Access key","required":["account","key"],"properties":{"account":{"type":"string","pattern":"^[a-zA-Z0-9]+$","isRequired":true,"uniqueKey":"deliver.oneOf.0.credentials.oneOf.0.account","typeLabel":"string"},"key":{"type":"string","format":"byte","isRequired":true,"uniqueKey":"deliver.oneOf.0.credentials.oneOf.0.key","typeLabel":"string\u003cbyte>"},"sas_token":{"type":"string","uniqueKey":"deliver.oneOf.0.credentials.oneOf.0.sas_token","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"deliver.oneOf.0.credentials.oneOf.0","typeLabel":"Access key · object"},{"type":"object","title":"Shared access token","required":["account","sas_token"],"properties":{"account":{"type":"string","pattern":"^[a-zA-Z0-9]+$","isRequired":true,"uniqueKey":"deliver.oneOf.0.credentials.oneOf.1.account","typeLabel":"string"},"sas_token":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.0.credentials.oneOf.1.sas_token","typeLabel":"string"},"key":{"type":"string","format":"byte","uniqueKey":"deliver.oneOf.0.credentials.oneOf.1.key","typeLabel":"string\u003cbyte>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"deliver.oneOf.0.credentials.oneOf.1","typeLabel":"Shared access token · object"}],"isRequired":true,"uniqueKey":"deliver.oneOf.0.credentials","typeLabel":"Access key · object | Shared access token · object"},"directory":{"type":"string","uniqueKey":"deliver.oneOf.0.directory","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"deliver.oneOf.0","typeLabel":"Microsoft Azure · object"},{"type":"object","title":"Build","description":"Deliver configuration","required":["type","filename"],"properties":{"type":{"type":"string","description":"Type of the delivery target","enum":["build"],"isRequired":true,"uniqueKey":"deliver.oneOf.1.type","typeLabel":"enum\u003cstring>"},"filename":{"type":"object","additionalProperties":false,"properties":{"template":{"type":"string","description":"Template for the filename, including placeholders.","isRequired":true,"uniqueKey":"deliver.oneOf.1.filename.template","typeLabel":"string"},"extension":{"type":"string","enum":["json","csv","xlsx","ndjson","parquet","jsonl"],"isRequired":true,"uniqueKey":"deliver.oneOf.1.filename.extension","typeLabel":"enum\u003cstring>"}},"required":["template","extension"],"isRequired":true,"uniqueKey":"deliver.oneOf.1.filename","typeLabel":"object"},"endpoint":{"type":"string","format":"uri","description":"The endpoint URL for the webhook.","uniqueKey":"deliver.oneOf.1.endpoint","typeLabel":"string\u003curi>"}},"additionalProperties":false,"uniqueKey":"deliver.oneOf.1","typeLabel":"Build · object"},{"type":"object","title":"Email","description":"Deliver configuration","required":["type","filename"],"properties":{"type":{"type":"string","description":"Type of the delivery target","enum":["email"],"isRequired":true,"uniqueKey":"deliver.oneOf.2.type","typeLabel":"enum\u003cstring>"},"filename":{"type":"object","additionalProperties":false,"properties":{"template":{"type":"string","description":"Template for the filename, including placeholders.","isRequired":true,"uniqueKey":"deliver.oneOf.2.filename.template","typeLabel":"string"},"extension":{"type":"string","enum":["json","csv","xlsx","ndjson","parquet","jsonl"],"isRequired":true,"uniqueKey":"deliver.oneOf.2.filename.extension","typeLabel":"enum\u003cstring>"}},"required":["template","extension"],"isRequired":true,"uniqueKey":"deliver.oneOf.2.filename","typeLabel":"object"},"address":{"type":"string","format":"email","description":"The recipient email address.","uniqueKey":"deliver.oneOf.2.address","typeLabel":"string\u003cemail>"}},"additionalProperties":false,"uniqueKey":"deliver.oneOf.2","typeLabel":"Email · object"},{"type":"object","title":"Google Cloud","description":"Deliver configuration","required":["bucket","credentials","type","filename"],"properties":{"type":{"type":"string","description":"Type of the delivery target","enum":["gcs"],"isRequired":true,"uniqueKey":"deliver.oneOf.3.type","typeLabel":"enum\u003cstring>"},"filename":{"type":"object","additionalProperties":false,"properties":{"template":{"type":"string","description":"Template for the filename, including placeholders.","isRequired":true,"uniqueKey":"deliver.oneOf.3.filename.template","typeLabel":"string"},"extension":{"type":"string","enum":["json","csv","xlsx","ndjson","parquet","jsonl"],"isRequired":true,"uniqueKey":"deliver.oneOf.3.filename.extension","typeLabel":"enum\u003cstring>"}},"required":["template","extension"],"isRequired":true,"uniqueKey":"deliver.oneOf.3.filename","typeLabel":"object"},"bucket":{"type":"string","description":"Name of the bucket.","isRequired":true,"uniqueKey":"deliver.oneOf.3.bucket","typeLabel":"string"},"credentials":{"type":"object","additionalProperties":false,"description":"Credentials for authentication","properties":{"client_email":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.3.credentials.client_email","typeLabel":"string"},"private_key":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.3.credentials.private_key","typeLabel":"string"}},"required":["client_email","private_key"],"isRequired":true,"uniqueKey":"deliver.oneOf.3.credentials","typeLabel":"object"},"directory":{"type":"string","description":"Target path","uniqueKey":"deliver.oneOf.3.directory","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"deliver.oneOf.3","typeLabel":"Google Cloud · object"},{"type":"object","title":"Google Cloud PubSub","description":"Deliver configuration","required":["topic_id","credentials","type","filename"],"properties":{"type":{"type":"string","description":"Type of the delivery target","enum":["gcp_pubsub"],"isRequired":true,"uniqueKey":"deliver.oneOf.4.type","typeLabel":"enum\u003cstring>"},"filename":{"type":"object","additionalProperties":false,"properties":{"template":{"type":"string","description":"Template for the filename, including placeholders.","isRequired":true,"uniqueKey":"deliver.oneOf.4.filename.template","typeLabel":"string"},"extension":{"type":"string","enum":["json","csv","xlsx","ndjson","parquet","jsonl"],"isRequired":true,"uniqueKey":"deliver.oneOf.4.filename.extension","typeLabel":"enum\u003cstring>"}},"required":["template","extension"],"isRequired":true,"uniqueKey":"deliver.oneOf.4.filename","typeLabel":"object"},"topic_id":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.4.topic_id","typeLabel":"string"},"credentials":{"type":"object","additionalProperties":false,"properties":{"client_email":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.4.credentials.client_email","typeLabel":"string"},"private_key":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.4.credentials.private_key","typeLabel":"string"}},"required":["client_email","private_key"],"isRequired":true,"uniqueKey":"deliver.oneOf.4.credentials","typeLabel":"object"},"attributes":{"type":"array","items":{"type":"object","uniqueKey":"deliver.oneOf.4.attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"deliver.oneOf.4.attributes","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"deliver.oneOf.4","typeLabel":"Google Cloud PubSub · object"},{"type":"object","title":"Amazon S3","description":"Deliver configuration","required":["bucket","credentials","type","filename"],"properties":{"type":{"type":"string","description":"Type of the delivery target","enum":["s3"],"isRequired":true,"uniqueKey":"deliver.oneOf.5.type","typeLabel":"enum\u003cstring>"},"filename":{"type":"object","additionalProperties":false,"properties":{"template":{"type":"string","description":"Template for the filename, including placeholders.","isRequired":true,"uniqueKey":"deliver.oneOf.5.filename.template","typeLabel":"string"},"extension":{"type":"string","enum":["json","csv","xlsx","ndjson","parquet","jsonl"],"isRequired":true,"uniqueKey":"deliver.oneOf.5.filename.extension","typeLabel":"enum\u003cstring>"}},"required":["template","extension"],"isRequired":true,"uniqueKey":"deliver.oneOf.5.filename","typeLabel":"object"},"bucket":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.5.bucket","typeLabel":"string"},"credentials":{"oneOf":[{"type":"object","title":"Role ARN","minProperties":2,"required":["role_arn","external_id"],"properties":{"role_arn":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.5.credentials.oneOf.0.role_arn","typeLabel":"string"},"external_id":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.5.credentials.oneOf.0.external_id","typeLabel":"string"},"aws-access-key":{"type":"string","uniqueKey":"deliver.oneOf.5.credentials.oneOf.0.aws-access-key","typeLabel":"string"},"aws-secret-key":{"type":"string","uniqueKey":"deliver.oneOf.5.credentials.oneOf.0.aws-secret-key","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"deliver.oneOf.5.credentials.oneOf.0","typeLabel":"Role ARN · object"},{"type":"object","title":"Access Key","minProperties":2,"required":["aws-access-key","aws-secret-key"],"properties":{"aws-access-key":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.5.credentials.oneOf.1.aws-access-key","typeLabel":"string"},"aws-secret-key":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.5.credentials.oneOf.1.aws-secret-key","typeLabel":"string"},"role_arn":{"type":"string","uniqueKey":"deliver.oneOf.5.credentials.oneOf.1.role_arn","typeLabel":"string"},"external_id":{"type":"string","uniqueKey":"deliver.oneOf.5.credentials.oneOf.1.external_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"deliver.oneOf.5.credentials.oneOf.1","typeLabel":"Access Key · object"}],"isRequired":true,"uniqueKey":"deliver.oneOf.5.credentials","typeLabel":"Role ARN · object | Access Key · object"},"endpoint_url":{"type":"string","description":"S3 like host url, available only with Access Key auth","uniqueKey":"deliver.oneOf.5.endpoint_url","typeLabel":"string"},"region":{"type":"string","uniqueKey":"deliver.oneOf.5.region","typeLabel":"string"},"directory":{"type":"string","uniqueKey":"deliver.oneOf.5.directory","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"deliver.oneOf.5","typeLabel":"Amazon S3 · object"},{"type":"object","title":"SFTP","description":"Deliver configuration","required":["path","credentials","type","filename"],"properties":{"type":{"type":"string","description":"Type of the delivery target","enum":["sftp"],"isRequired":true,"uniqueKey":"deliver.oneOf.6.type","typeLabel":"enum\u003cstring>"},"filename":{"type":"object","additionalProperties":false,"properties":{"template":{"type":"string","description":"Template for the filename, including placeholders.","isRequired":true,"uniqueKey":"deliver.oneOf.6.filename.template","typeLabel":"string"},"extension":{"type":"string","enum":["json","csv","xlsx","ndjson","parquet","jsonl"],"isRequired":true,"uniqueKey":"deliver.oneOf.6.filename.extension","typeLabel":"enum\u003cstring>"}},"required":["template","extension"],"isRequired":true,"uniqueKey":"deliver.oneOf.6.filename","typeLabel":"object"},"path":{"type":"string","format":"hostname","isRequired":true,"uniqueKey":"deliver.oneOf.6.path","typeLabel":"string\u003chostname>"},"credentials":{"type":"object","additionalProperties":false,"properties":{"username":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.6.credentials.username","typeLabel":"string"},"password":{"type":"string","uniqueKey":"deliver.oneOf.6.credentials.password","typeLabel":"string"},"ssh_key":{"type":"string","uniqueKey":"deliver.oneOf.6.credentials.ssh_key","typeLabel":"string"},"passphrase":{"type":"string","uniqueKey":"deliver.oneOf.6.credentials.passphrase","typeLabel":"string"}},"required":["username"],"isRequired":true,"uniqueKey":"deliver.oneOf.6.credentials","typeLabel":"object"},"port":{"type":"integer","minimum":0,"maximum":65535,"uniqueKey":"deliver.oneOf.6.port","typeLabel":"integer"},"directory":{"type":"string","uniqueKey":"deliver.oneOf.6.directory","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"deliver.oneOf.6","typeLabel":"SFTP · object"},{"type":"object","title":"Snowflake","description":"Deliver configuration","required":["database","schema","stage","role","warehouse","credentials","type","filename"],"properties":{"type":{"type":"string","description":"Type of the delivery target","enum":["snowflake"],"isRequired":true,"uniqueKey":"deliver.oneOf.7.type","typeLabel":"enum\u003cstring>"},"filename":{"type":"object","additionalProperties":false,"properties":{"template":{"type":"string","description":"Template for the filename, including placeholders.","isRequired":true,"uniqueKey":"deliver.oneOf.7.filename.template","typeLabel":"string"},"extension":{"type":"string","enum":["json","csv","xlsx","ndjson","parquet","jsonl"],"isRequired":true,"uniqueKey":"deliver.oneOf.7.filename.extension","typeLabel":"enum\u003cstring>"}},"required":["template","extension"],"isRequired":true,"uniqueKey":"deliver.oneOf.7.filename","typeLabel":"object"},"database":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.7.database","typeLabel":"string"},"schema":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.7.schema","typeLabel":"string"},"stage":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.7.stage","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.7.role","typeLabel":"string"},"warehouse":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.7.warehouse","typeLabel":"string"},"credentials":{"type":"object","additionalProperties":false,"properties":{"account":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.7.credentials.account","typeLabel":"string"},"user":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.7.credentials.user","typeLabel":"string"},"password":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.7.credentials.password","typeLabel":"string"}},"required":["account","user","password"],"isRequired":true,"uniqueKey":"deliver.oneOf.7.credentials","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"deliver.oneOf.7","typeLabel":"Snowflake · object"},{"type":"object","title":"Webhook","description":"Deliver configuration","required":["type","filename"],"properties":{"type":{"type":"string","description":"Type of the delivery target","enum":["webhook"],"isRequired":true,"uniqueKey":"deliver.oneOf.8.type","typeLabel":"enum\u003cstring>"},"filename":{"type":"object","additionalProperties":false,"properties":{"template":{"type":"string","description":"Template for the filename, including placeholders.","isRequired":true,"uniqueKey":"deliver.oneOf.8.filename.template","typeLabel":"string"},"extension":{"type":"string","enum":["json","csv","xlsx","ndjson","parquet","jsonl"],"isRequired":true,"uniqueKey":"deliver.oneOf.8.filename.extension","typeLabel":"enum\u003cstring>"}},"required":["template","extension"],"isRequired":true,"uniqueKey":"deliver.oneOf.8.filename","typeLabel":"object"},"endpoint":{"type":"string","format":"uri","description":"The endpoint URL for the webhook.","uniqueKey":"deliver.oneOf.8.endpoint","typeLabel":"string\u003curi>"}},"additionalProperties":false,"uniqueKey":"deliver.oneOf.8","typeLabel":"Webhook · object"},{"type":"object","title":"Aliyun Object Storage Service","description":"Deliver configuration","required":["bucket","credentials","region","type","filename"],"properties":{"type":{"type":"string","description":"Type of the delivery target","enum":["ali_oss"],"isRequired":true,"uniqueKey":"deliver.oneOf.9.type","typeLabel":"enum\u003cstring>"},"filename":{"type":"object","additionalProperties":false,"properties":{"template":{"type":"string","description":"Template for the filename, including placeholders.","isRequired":true,"uniqueKey":"deliver.oneOf.9.filename.template","typeLabel":"string"},"extension":{"type":"string","enum":["json","csv","xlsx","ndjson","parquet","jsonl"],"isRequired":true,"uniqueKey":"deliver.oneOf.9.filename.extension","typeLabel":"enum\u003cstring>"}},"required":["template","extension"],"isRequired":true,"uniqueKey":"deliver.oneOf.9.filename","typeLabel":"object"},"bucket":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.9.bucket","typeLabel":"string"},"credentials":{"type":"object","additionalProperties":false,"properties":{"access-key":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.9.credentials.access-key","typeLabel":"string"},"secret-key":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.9.credentials.secret-key","typeLabel":"string"}},"required":["access-key","secret-key"],"isRequired":true,"uniqueKey":"deliver.oneOf.9.credentials","typeLabel":"object"},"region":{"type":"string","isRequired":true,"uniqueKey":"deliver.oneOf.9.region","typeLabel":"string"},"directory":{"type":"string","uniqueKey":"deliver.oneOf.9.directory","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"deliver.oneOf.9","typeLabel":"Aliyun Object Storage Service · object"}],"uniqueKey":"deliver","typeLabel":"Microsoft Azure · object | Build · object | Email · object | Google Cloud · object | Google Cloud PubSub · object | Amazon S3 · object | SFTP · object | Snowflake · object | Webhook · object | Aliyun Object Storage Service · object"},"compress":{"type":"boolean","description":"Deliver file compressed in gzip format","default":false,"uniqueKey":"compress","typeLabel":"boolean"},"batch_size":{"type":"integer","description":"Number of records per file. Use this to split large snapshots into multiple smaller files. Files are split by record count. Recommended for snapshots with more than 1 million records. Note: Maximum batch size is 5GB.","examples":[100000],"uniqueKey":"batch_size","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"deliver":{"type":"azure","filename":{"template":"\u003cstring>"},"container":"\u003cstring>","credentials":{"account":"\u003cstring>","key":"aSDinaTvuI8gbWludGxpZnk=","sas_token":"\u003cstring>"},"directory":"\u003cstring>"},"compress":false,"batch_size":100000}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"fa9ca4bf-3fd2-4118-9f72-ea9889eac302":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The delivery job ID. Use this ID to track the delivery status (see [Tracking delivery status](/api-reference/marketplace-dataset-api/deliver-snapshot#tracking-delivery-status)).","uniqueKey":"id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"del_abc123xyz"},"examples":{"Example":{"title":"Example","value":{"id":"del_abc123xyz"}}},"exampleType":"examples"}},"exampleType":"examples"},"23cd833b-9070-474a-b535-ed850ee717d9":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Batch size exceeds 5GB limit","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Batch size exceeds 5GB limit"}}},"exampleType":"generated"}},"exampleType":"generated"},"8a7eb602-a5cb-4389-a1fb-289d32f6bfb0":{"description":"Snapshot not found or isn't in ready status.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Snapshot not found","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Snapshot not found"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3572c80a-5226-415b-a727-65415715e451":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Use your Bright Data API Key as a Bearer token in the Authorization header.\n\n**How to authenticate:**\n1. Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users\n2. Include the API Key in the Authorization header of your requests\n3. Format: `Authorization: Bearer YOUR_API_KEY`\n\n**Example:**\n```\nAuthorization: Bearer YOUR_API_KEY\n```\n\nLearn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication","bearerFormat":"API Key","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"5fec9d8b-5423-468e-8516-c22c4945afdb":{"url":"https://api.brightdata.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Use your Bright Data API Key as a Bearer token in the Authorization header.\n\n**How to authenticate:**\n1. Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users\n2. Include the API Key in the Authorization header of your requests\n3. Format: `Authorization: Bearer YOUR_API_KEY`\n\n**Example:**\n```\nAuthorization: Bearer YOUR_API_KEY\n```\n\nLearn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication","bearerFormat":"API Key","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use your Bright Data API Key as a Bearer token in the Authorization header.\n\n**How to authenticate:**\n1. Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users\n2. Include the API Key in the Authorization header of your requests\n3. Format: `Authorization: Bearer YOUR_API_KEY`\n\n**Example:**\n```\nAuthorization: Bearer YOUR_API_KEY\n```\n\nLearn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/dca-api.json"},"subdomain":"brightdata","siteName":"Bright Data Docs","title":"Deliver snapshot - Bright Data Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/marketplace-dataset-api/deliver-snapshot","matchLevel":0},"cn":{"href":"/cn/api-reference/marketplace-dataset-api/deliver-snapshot","matchLevel":1}}},"lastModified":"2026-11-12T11:38:27.995Z","originalFileLocation":"api-reference/marketplace-dataset-api/deliver-snapshot.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Use the Bright Data Marketplace Dataset API to deliver a Snapshot. POST /datasets/snapshots/{id}/deliver returns 200 OK with metadata as JSON.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bright Data Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/brightdata/uUUbPQlQGu6JyjN0/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/brightdata/uUUbPQlQGu6JyjN0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/brightdata/uUUbPQlQGu6JyjN0/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/brightdata/uUUbPQlQGu6JyjN0/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/brightdata/uUUbPQlQGu6JyjN0/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/brightdata/uUUbPQlQGu6JyjN0/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/brightdata/uUUbPQlQGu6JyjN0/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/brightdata/uUUbPQlQGu6JyjN0/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/brightdata/uUUbPQlQGu6JyjN0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Deliver snapshot - Bright Data Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Use the Bright Data Marketplace Dataset API to deliver a Snapshot. POST /datasets/snapshots/{id}/deliver returns 200 OK with metadata as JSON.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bright Data Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.brightdata.com/api-reference/marketplace-dataset-api/deliver-snapshot\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://brightdata.mintlify.site/_mintlify/api/og/v2?division=Dataset+Marketplace+API\u0026amp;title=Deliver+snapshot\u0026amp;description=Use+the+Bright+Data+Marketplace+Dataset+API+to+deliver+a+Snapshot.+POST+%2Fdatasets%2Fsnapshots%2F%7Bid%7D%2Fdeliver+returns+200+OK+with+metadata+as+JSON.\u0026amp;theme=7da10763b4cc41bb49d4e8a2\u0026amp;signature=f5a1eef97eae1b40c81aadded11de0fda7f857b6ddd139434a8d782fc813d8c3\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Deliver snapshot - Bright Data Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Use the Bright Data Marketplace Dataset API to deliver a Snapshot. POST /datasets/snapshots/{id}/deliver returns 200 OK with metadata as JSON.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://brightdata.mintlify.site/_mintlify/api/og/v2?division=Dataset+Marketplace+API\u0026amp;title=Deliver+snapshot\u0026amp;description=Use+the+Bright+Data+Marketplace+Dataset+API+to+deliver+a+Snapshot.+POST+%2Fdatasets%2Fsnapshots%2F%7Bid%7D%2Fdeliver+returns+200+OK+with+metadata+as+JSON.\u0026amp;theme=7da10763b4cc41bb49d4e8a2\u0026amp;signature=f5a1eef97eae1b40c81aadded11de0fda7f857b6ddd139434a8d782fc813d8c3\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/brightdata/uUUbPQlQGu6JyjN0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bright Data Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4180f9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.brightdata.com/api-reference/marketplace-dataset-api/deliver-snapshot\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/marketplace-dataset-api/deliver-snapshot.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.brightdata.com/api-reference/marketplace-dataset-api/deliver-snapshot\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.brightdata.com/cn/api-reference/marketplace-dataset-api/deliver-snapshot\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.brightdata.com/api-reference/marketplace-dataset-api/deliver-snapshot\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.brightdata.com/#organization\",\"name\":\"Bright Data Docs\",\"url\":\"https://docs.brightdata.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/brightdata/FreEYbEGZchU-2Iw/logo/light.svg?fit=max\u0026auto=format\u0026n=FreEYbEGZchU-2Iw\u0026q=85\u0026s=fa5461a75d0b4cf2e744c89d4b67afac\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.brightdata.com#website\",\"name\":\"Bright Data Docs\",\"url\":\"https://docs.brightdata.com\",\"publisher\":{\"@id\":\"https://docs.brightdata.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.brightdata.com/api-reference/marketplace-dataset-api/deliver-snapshot#webpage\",\"url\":\"https://docs.brightdata.com/api-reference/marketplace-dataset-api/deliver-snapshot\",\"name\":\"Deliver snapshot\",\"description\":\"Use the Bright Data Marketplace Dataset API to deliver a Snapshot. POST /datasets/snapshots/{id}/deliver returns 200 OK with metadata as JSON.\",\"dateModified\":\"2026-11-12T11:38:27.995Z\",\"isPartOf\":{\"@id\":\"https://docs.brightdata.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.brightdata.com/api-reference/marketplace-dataset-api/deliver-snapshot#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.brightdata.com/api-reference/marketplace-dataset-api/deliver-snapshot#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Data extraction\",\"item\":\"https://docs.brightdata.com/api-reference/rest-api/scraper/asynchronous-requests\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Dataset Marketplace API\",\"item\":\"https://docs.brightdata.com/api-reference/marketplace-dataset-api/get-dataset-list\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Deliver snapshot\",\"item\":\"https://docs.brightdata.com/api-reference/marketplace-dataset-api/deliver-snapshot\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.brightdata.com/api-reference/marketplace-dataset-api/deliver-snapshot#apireference\",\"headline\":\"Deliver snapshot\",\"name\":\"Deliver snapshot\",\"description\":\"Use the Bright Data Marketplace Dataset API to deliver a Snapshot. POST /datasets/snapshots/{id}/deliver returns 200 OK with metadata as JSON.\",\"url\":\"https://docs.brightdata.com/api-reference/marketplace-dataset-api/deliver-snapshot\",\"mainEntityOfPage\":{\"@id\":\"https://docs.brightdata.com/api-reference/marketplace-dataset-api/deliver-snapshot#webpage\"},\"dateModified\":\"2026-11-12T11:38:27.995Z\",\"publisher\":{\"@id\":\"https://docs.brightdata.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.brightdata.com#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/marketplace-dataset-api/deliver-snapshot.md","siteName":"Bright Data Docs","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API reference","groups":[{"group":"Essentials","pages":[{"title":"Authentication","icon":"shield-keyhole","href":"/api-reference/authentication"},{"title":"Terminology","icon":"clipboard-list","href":"/api-reference/terminology"},{"group":"CLI","icon":"terminal","pages":[{"title":"Bright Data CLI","sidebarTitle":"Overview","icon":"terminal","href":"/products/cli/overview"},{"title":"Install the Bright Data CLI","sidebarTitle":"Installation","icon":"download","href":"/products/cli/installation"},{"title":"Bright Data CLI command reference","sidebarTitle":"Commands","icon":"code","href":"/products/cli/commands"},{"title":"Usage examples","sidebarTitle":"Examples","icon":"book-open","href":"/products/cli/examples"},{"title":"Bright Data CLI FAQs","sidebarTitle":"FAQs","icon":"question","href":"/products/cli/faqs"}]},{"title":"Python SDK","sidebarTitle":"Python SDK","icon":"Python","href":"/api-reference/SDK"},{"sidebarTitle":"JavaScript SDK","icon":"node-js","title":"JavaScript SDK","href":"/api-reference/SDK-JS"}]},{"group":"Data extraction","pages":[{"group":"Scraper API","pages":[{"title":"Scraper async requests","sidebarTitle":"Asynchronous requests","openapi":"api-reference/rest-api/scraper/scraper-rest-api.json POST /datasets/v3/trigger","href":"/api-reference/rest-api/scraper/asynchronous-requests"},{"title":"Synchronous requests","sidebarTitle":"Synchronous requests","openapi":"api-reference/dca-api POST /datasets/v3/scrape","href":"/api-reference/scrapers/synchronous-requests"},{"group":"Delivery APIs","pages":[{"title":"Download snapshot","openapi":"api-reference/dca-api GET /datasets/v3/snapshot/{snapshot_id}","href":"/api-reference/scrapers/delivery-apis/download-snapshot"},{"title":"Deliver snapshot to storage or webhook","sidebarTitle":"Deliver snapshot","openapi":"api-reference/dca-api POST /datasets/v3/deliver/{snapshot_id}","href":"/api-reference/scrapers/delivery-apis/deliver-snapshot"}]},{"group":"Management APIs","pages":[{"title":"Get all scrapers","openapi":"api-reference/dca-api get /datasets/v3/scrapers","sidebarTitle":"All scrapers","href":"/api-reference/scrapers/management-apis/get-scrapers"},{"title":"Monitor progress","openapi":"api-reference/dca-api get /datasets/v3/progress/{snapshot_id}","href":"/api-reference/scrapers/management-apis/monitor-progress"},{"title":"Get snapshots","openapi":"api-reference/dca-api get /datasets/v3/snapshots","sidebarTitle":"Snapshots","href":"/api-reference/scrapers/management-apis/get-snapshots"},{"title":"Monitor delivery","openapi":"api-reference/dca-api get /datasets/v3/delivery/{delivery_id}","href":"/api-reference/scrapers/management-apis/monitor-delivery"},{"title":"Get snapshot delivery parts","openapi":"api-reference/dca-api get /datasets/v3/snapshot/{snapshot_id}/parts","sidebarTitle":"Snapshot delivery parts","href":"/api-reference/scrapers/management-apis/get-snapshot-delivery-parts"},{"title":"Get snapshot input","openapi":"api-reference/dca-api get /datasets/v3/snapshot/{snapshot_id}/input","sidebarTitle":"Snapshot input","href":"/api-reference/scrapers/management-apis/get-snapshot-input"},{"title":"Get snapshot log","openapi":"api-reference/dca-api get /datasets/v3/log/{snapshot_id}","sidebarTitle":"Snapshot log","href":"/api-reference/scrapers/management-apis/snapshot-data"},{"title":"Cancel snapshot","openapi":"api-reference/dca-api post /datasets/v3/snapshot/{snapshot_id}/cancel","href":"/api-reference/scrapers/management-apis/cancel-snapshot"},{"title":"Pause snapshot","openapi":"api-reference/dca-api post /datasets/v3/snapshot/{snapshot_id}/pause","href":"/api-reference/scrapers/management-apis/pause-snapshot"},{"title":"Resume snapshot","openapi":"api-reference/dca-api post /datasets/v3/snapshot/{snapshot_id}/resume","href":"/api-reference/scrapers/management-apis/resume-snapshot"},{"title":"Rerun snapshot","openapi":"api-reference/dca-api post /datasets/v3/snapshot/{snapshot_id}/rerun","href":"/api-reference/scrapers/management-apis/rerun-snapshot"},{"title":"Get scraper fill rates","openapi":"api-reference/dca-api get /datasets/v3/scraper/{dataset_id}/fill_rate","sidebarTitle":"Scraper fill rates","href":"/api-reference/scrapers/management-apis/get-fill-rates"},{"title":"Get snapshot fill rates","openapi":"api-reference/dca-api get /datasets/v3/snapshot/{snapshot_id}/fill_rate","sidebarTitle":"Snapshot fill rates","href":"/api-reference/scrapers/management-apis/get-snapshot-fill-rates"}]},{"group":"Social Media APIs","pages":[{"title":"Social media scraper APIs","sidebarTitle":"Overview","href":"/api-reference/scrapers/social-media-apis/overview"},{"group":"Facebook","pages":[{"title":"Scrape Facebook page posts by URL","sidebarTitle":"Page posts - Collect by URL","openapi":"api-reference/sdk-specs/facebook-pages-posts-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-pages-posts-collect-by-url"},{"title":"Discover Facebook page posts by username","sidebarTitle":"Page posts - Discover by username","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-pages-posts-discover-by-username"},{"title":"Scrape Facebook comments by URL","sidebarTitle":"Comments - Collect by URL","openapi":"api-reference/sdk-specs/facebook-comments-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-comments-collect-by-url"},{"title":"Scrape Facebook group posts by URL","sidebarTitle":"Posts by group - Collect by URL","openapi":"api-reference/sdk-specs/facebook-posts-by-group-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-posts-by-group-collect-by-url"},{"title":"Scrape Facebook posts by URL","sidebarTitle":"Posts - Collect by URL","openapi":"api-reference/sdk-specs/facebook-posts-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-posts-collect-by-url"},{"title":"Scrape Facebook Marketplace by URL","sidebarTitle":"Marketplace - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-marketplace-collect-by-url"},{"title":"Discover Facebook Marketplace by keyword","sidebarTitle":"Marketplace - Discover by keyword","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-marketplace-discover-by-keyword"},{"title":"Discover Facebook Marketplace by URL","sidebarTitle":"Marketplace - Discover by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-marketplace-discover-by-url"},{"title":"Scrape Facebook profiles by URL","sidebarTitle":"Profiles - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-profiles-collect-by-url"},{"title":"Scrape Facebook pages and profiles by URL","sidebarTitle":"Pages and profiles - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-pages-and-profiles-collect-by-url"},{"title":"Scrape Facebook events by URL","sidebarTitle":"Events - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-events-collect-by-url"},{"title":"Discover Facebook events by URL","sidebarTitle":"Events - Discover by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-events-discover-by-url"},{"title":"Discover Facebook events by venue","sidebarTitle":"Events - Discover by venue","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-events-discover-by-venue"},{"title":"Scrape Facebook reels by profile URL","sidebarTitle":"Reels - Collect by URL","openapi":"api-reference/sdk-specs/facebook-reels-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-reels-collect-by-url"},{"title":"Scrape Facebook company reviews by URL","sidebarTitle":"Company reviews - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/facebook-company-reviews-collect-by-url"}]},{"group":"Instagram","pages":[{"title":"Scrape Instagram profiles by URL","sidebarTitle":"Profiles - Collect by URL","openapi":"api-reference/sdk-specs/instagram-profiles-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/instagram-profiles-collect-by-url"},{"title":"Discover Instagram profiles by username","sidebarTitle":"Profiles - Discover by username","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/instagram-profiles-discover-by-username"},{"title":"Scrape Instagram posts by URL","sidebarTitle":"Posts - Collect by URL","openapi":"api-reference/sdk-specs/instagram-posts-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/instagram-posts-collect-by-url"},{"title":"Discover Instagram posts by URL","sidebarTitle":"Posts - Discover by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/instagram-posts-discover-by-url"},{"title":"Scrape Instagram reels by URL","sidebarTitle":"Reels - Collect by URL","openapi":"api-reference/sdk-specs/instagram-reels-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/instagram-reels-collect-by-url"},{"title":"Discover Instagram reels by URL","sidebarTitle":"Reels - Discover by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/instagram-reels-discover-by-url"},{"title":"Scrape all Instagram reels","sidebarTitle":"Reels - Collect all","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/instagram-reels-collect-all"},{"title":"Scrape Instagram comments by URL","sidebarTitle":"Comments - Collect by URL","openapi":"api-reference/sdk-specs/instagram-comments-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/instagram-comments-collect-by-url"}]},{"group":"LinkedIn","pages":[{"title":"Scrape LinkedIn profiles by URL","sidebarTitle":"Collect profiles by URL","openapi":"api-reference/sdk-specs/linkedin-profiles-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/linkedin-profiles-collect-by-url"},{"title":"Scrape LinkedIn companies by URL","sidebarTitle":"Collect companies by URL","openapi":"api-reference/sdk-specs/linkedin-companies-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/linkedin-companies-collect-by-url"},{"title":"Discover LinkedIn jobs by URL","sidebarTitle":"Discover jobs by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/linkedin-jobs-discover-by-url"},{"title":"Scrape LinkedIn jobs by URL","sidebarTitle":"Collect jobs by URL","openapi":"api-reference/sdk-specs/linkedin-jobs-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/linkedin-jobs-collect-by-url"},{"title":"Discover LinkedIn jobs by keyword","sidebarTitle":"Discover jobs by keyword","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/linkedin-jobs-discover-by-keyword"},{"title":"Discover LinkedIn posts by profile URL","sidebarTitle":"Discover posts by profile URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/linkedin-posts-discover-by-profile-url"},{"title":"Discover LinkedIn posts by URL","sidebarTitle":"Discover posts by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/linkedin-posts-discover-by-url"},{"title":"Scrape LinkedIn posts by URL","sidebarTitle":"Collect posts by URL","openapi":"api-reference/sdk-specs/linkedin-posts-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/linkedin-posts-collect-by-url"},{"title":"Discover LinkedIn posts by company URL","sidebarTitle":"Discover posts by company URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/linkedin-posts-discover-by-company-url"},{"title":"Discover new LinkedIn profiles","sidebarTitle":"Discover new profiles","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/linkedin-people-discover-new-profiles"}]},{"group":"TikTok","pages":[{"title":"Scrape TikTok profiles by URL","sidebarTitle":"Profiles - Collect by URL","openapi":"api-reference/sdk-specs/tiktok-profiles-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/tiktok-profiles-collect-by-url"},{"title":"Discover TikTok profiles by search URL","sidebarTitle":"Profiles - Discover by search URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/tiktok-profiles-discover-by-search-url"},{"title":"Scrape TikTok posts by URL","sidebarTitle":"Posts - Collect by URL","openapi":"api-reference/sdk-specs/tiktok-posts-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/tiktok-posts-collect-by-url"},{"title":"Discover TikTok posts by keyword","sidebarTitle":"Posts - Discover by keyword","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/tiktok-posts-discover-by-keyword"},{"title":"Discover TikTok posts by profile URL","sidebarTitle":"Posts - Discover by profile URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/tiktok-posts-discover-by-profile-url"},{"title":"Discover TikTok posts by URL","sidebarTitle":"Posts - Discover by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/tiktok-posts-discover-by-url"},{"title":"Scrape TikTok Shop products by URL","sidebarTitle":"Shop - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/tiktok-shop-collect-by-url"},{"title":"Discover TikTok Shop products by category","sidebarTitle":"Shop - Discover by category","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/tiktok-shop-discover-by-category"},{"title":"Discover TikTok Shop products by keyword","sidebarTitle":"Shop - Discover by keyword","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/tiktok-shop-discover-by-keyword"},{"title":"Discover TikTok Shop products by shop","sidebarTitle":"Shop - Discover by shop","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/tiktok-shop-discover-by-shop"},{"title":"Scrape TikTok comments by URL","sidebarTitle":"Comments - Collect by URL","openapi":"api-reference/sdk-specs/tiktok-comments-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/tiktok-comments-collect-by-url"},{"title":"Scrape TikTok posts by profile Fast API","sidebarTitle":"Posts by profile Fast API - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/tiktok-posts-by-profile-fast-api-collect-by-url"}]},{"group":"Reddit","pages":[{"title":"Scrape Reddit posts by URL","sidebarTitle":"Posts - Collect by URL","openapi":"api-reference/sdk-specs/reddit-posts-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/reddit-posts-collect-by-url"},{"title":"Discover Reddit posts by keyword","sidebarTitle":"Posts - Discover by keyword","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/reddit-posts-discover-by-keyword"},{"title":"Discover Reddit posts by subreddit URL","sidebarTitle":"Posts - Discover by subreddit URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/reddit-posts-discover-by-subreddit-url"},{"title":"Scrape Reddit comments by URL","sidebarTitle":"Comments - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/reddit-comments-collect-by-url"}]},{"group":"X (Twitter)","pages":[{"title":"Scrape X (Twitter) posts by URL","sidebarTitle":"Posts - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/twitter-posts-collect-by-url"},{"title":"Scrape X (Twitter) profiles by URL","sidebarTitle":"Profiles - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/twitter-profiles-collect-by-url"},{"title":"Discover X (Twitter) profiles by username","sidebarTitle":"Profiles - Discover by username","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/twitter-profiles-discover-by-username"}]},{"title":"Pinterest API scrapers","sidebarTitle":"Pinterest","href":"/api-reference/scrapers/social-media-apis/pinterest"},{"title":"Quora API scrapers","sidebarTitle":"Quora","href":"/api-reference/scrapers/social-media-apis/quora"},{"title":"Vimeo API scrapers","sidebarTitle":"Vimeo","href":"/api-reference/scrapers/social-media-apis/vimeo"},{"group":"YouTube","pages":[{"title":"Scrape YouTube videos by URL","sidebarTitle":"Videos - Collect by URL","openapi":"api-reference/sdk-specs/youtube-videos-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/youtube-videos-collect-by-url"},{"title":"Discover YouTube videos from Explore","sidebarTitle":"Videos - Discover by explore","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/youtube-videos-discover-by-explore"},{"title":"Discover YouTube videos by hashtag","sidebarTitle":"Videos - Discover by hashtag","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/youtube-videos-discover-by-hashtag"},{"title":"Discover YouTube videos by keyword","sidebarTitle":"Videos - Discover by keyword","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/youtube-videos-discover-by-keyword"},{"title":"Discover YouTube videos by podcast URL","sidebarTitle":"Videos - Discover by podcast URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/youtube-videos-discover-by-podcast-url"},{"title":"Discover YouTube videos by search filters","sidebarTitle":"Videos - Discover by search filters","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/youtube-videos-discover-by-search-filters"},{"title":"Discover YouTube videos by URL","sidebarTitle":"Videos - Discover by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/youtube-videos-discover-by-url"},{"title":"Scrape YouTube channels by URL","sidebarTitle":"Channels - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/youtube-channels-collect-by-url"},{"title":"Discover YouTube channels by keyword","sidebarTitle":"Channels - Discover by keyword","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/youtube-channels-discover-by-keyword"},{"title":"Scrape YouTube comments by URL","sidebarTitle":"Comments - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/social-media-apis/youtube-comments-collect-by-url"}]}]},{"group":"E-Commerce APIs","pages":[{"group":"Amazon","pages":[{"title":"Scrape Amazon products by URL","sidebarTitle":"Products - Collect by URL","openapi":"api-reference/sdk-specs/amazon-products-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/e-commerce-apis/amazon-products-collect-by-url"},{"title":"Discover Amazon best sellers by URL","sidebarTitle":"Products - Discover by best sellers URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/e-commerce-apis/amazon-products-discover-by-best-sellers-url"},{"title":"Discover Amazon products by category URL","sidebarTitle":"Products - Discover by category URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/e-commerce-apis/amazon-products-discover-by-category-url"},{"title":"Discover Amazon products by keyword","sidebarTitle":"Products - Discover by keyword","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/e-commerce-apis/amazon-products-discover-by-keyword"},{"title":"Discover Amazon products by UPC","sidebarTitle":"Products - Discover by UPC","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/e-commerce-apis/amazon-products-discover-by-upc"},{"title":"Scrape Amazon reviews by URL","sidebarTitle":"Reviews - Collect by URL","openapi":"api-reference/sdk-specs/amazon-reviews-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/e-commerce-apis/amazon-reviews-collect-by-url"},{"title":"Scrape Amazon seller info by URL","sidebarTitle":"Sellers info - Collect by URL","openapi":"api-reference/sdk-specs/amazon-sellers-info-collect-by-url POST /datasets/v3/scrape","href":"/api-reference/scrapers/e-commerce-apis/amazon-sellers-info-collect-by-url"},{"title":"Scrape Amazon global products by URL","sidebarTitle":"Products global - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/e-commerce-apis/amazon-products-global-collect-by-url"},{"title":"Discover Amazon global by brand","sidebarTitle":"Products global - Discover by brand","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/e-commerce-apis/amazon-products-global-discover-by-brand"},{"title":"Discover Amazon global by category URL","sidebarTitle":"Products global - Discover by category URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/e-commerce-apis/amazon-products-global-discover-by-category-url"},{"title":"Discover Amazon global by keywords","sidebarTitle":"Products global - Discover by keywords","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/e-commerce-apis/amazon-products-global-discover-by-keywords"},{"title":"Discover Amazon global by seller","sidebarTitle":"Products global - Discover by seller","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/e-commerce-apis/amazon-products-global-discover-by-seller"},{"title":"Scrape Amazon product search by URL","sidebarTitle":"Products search - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/e-commerce-apis/amazon-products-search-collect-by-url"}]}]},{"group":"Search Engine APIs","pages":[{"group":"Google","pages":[{"title":"Scrape Google Maps places by URL","sidebarTitle":"Maps - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-maps-collect-by-url"},{"title":"Discover Google Maps places by CID","sidebarTitle":"Maps - Discover by CID","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-maps-discover-by-cid"},{"title":"Discover Google Maps places by place_id","sidebarTitle":"Maps - Discover by place_id","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-maps-discover-by-place-id"},{"title":"Discover Google Maps places by location","sidebarTitle":"Maps - Discover by location","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-maps-discover-by-location"},{"title":"Scrape Google Maps reviews by URL","sidebarTitle":"Maps reviews - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-maps-reviews-collect-by-url"},{"title":"Scrape Google Shopping products by URL","sidebarTitle":"Shopping - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-shopping-collect-by-url"},{"title":"Discover Google Shopping by keyword","sidebarTitle":"Shopping - Discover by keyword","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-shopping-discover-by-keyword"},{"title":"Scrape Google Shopping search (US) by URL","sidebarTitle":"Shopping search US - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-shopping-products-search-us-collect-by-url"},{"title":"Scrape Google SERP 100 results by URL","sidebarTitle":"SERP 100 - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-serp-100-collect-by-url"},{"title":"Scrape Google AI Mode search by URL","sidebarTitle":"AI Mode search - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-ai-mode-search-collect-by-url"},{"title":"Scrape Google Flights by URL","sidebarTitle":"Flights - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-flights-collect-by-url"},{"title":"Discover Google Flights by Input Filters","sidebarTitle":"Flights - Discover by input filters","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-flights-discover-by-input-filters"},{"title":"Scrape Google Hotels by URL","sidebarTitle":"Hotels - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-hotel-collect-by-url"},{"title":"Discover Google Hotels by filter URL","sidebarTitle":"Hotels - Discover by filter URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-hotel-discover-by-filter-url"},{"title":"Discover Google Hotels by Search","sidebarTitle":"Hotels - Discover by search","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/search-engines-apis/google-hotel-discover-by-search"}]}]},{"group":"AI Search APIs","pages":[{"title":"ChatGPT search by prompt","sidebarTitle":"ChatGPT search - Search by prompt","openapi":"api-reference/sdk-specs/chatgpt-search-by-prompt POST /datasets/v3/scrape","href":"/api-reference/scrapers/ai-search-apis/chatgpt-search-by-prompt"}]},{"group":"Web Content APIs","pages":[{"title":"Scrape any web page by URL with Fetch API","sidebarTitle":"Fetch API - Collect by URL","api":"POST https://api.brightdata.com/datasets/v3/scrape","href":"/api-reference/scrapers/web-content-apis/fetch-api-collect-by-url"}]}]},{"group":"Scraper Studio API","pages":[{"group":"Initiate collection","pages":[{"title":"Trigger async batch collection","sidebarTitle":"Trigger batch","openapi":"api-reference/web-scraper-ide-rest-api POST /dca/trigger","href":"/api-reference/scraper-studio-api/Trigger_a_scraper_for_batch_collection_method"},{"title":"Trigger async real-time scrape","sidebarTitle":"Trigger real-time (async)","openapi":"api-reference/web-scraper-ide-rest-api POST /dca/trigger_immediate","href":"/api-reference/scraper-studio-api/initiate-a-realtime-job/async-realtime-job"},{"title":"Trigger sync real-time scrape","sidebarTitle":"Trigger real-time (sync)","openapi":"api-reference/web-scraper-ide-rest-api POST /dca/crawl","href":"/api-reference/scraper-studio-api/initiate-a-realtime-job/sync-realtime-job"}]},{"group":"Retrieve data","pages":[{"title":"Receive batch data","sidebarTitle":"Batch data","openapi":"api-reference/web-scraper-ide-rest-api GET /dca/dataset","href":"/api-reference/scraper-studio-api/Receive_batch_data"},{"title":"Receive data from real-time work scraper","sidebarTitle":"Real-time data","openapi":"api-reference/web-scraper-ide-rest-api GET /dca/get_result","href":"/api-reference/scraper-studio-api/Receive_data_from_real_time_work_scraper"}]},{"group":"Manage jobs","pages":[{"title":"Get job metadata","sidebarTitle":"Job metadata","openapi":"api-reference/web-scraper-ide-rest-api GET /dca/log/{job_id}","href":"/api-reference/scraper-studio-api/job-data"},{"title":"Pause a Scraper Studio job","sidebarTitle":"Pause job","openapi":"api-reference/web-scraper-ide-rest-api POST /dca/jobs/{job_id}/pause","href":"/api-reference/scraper-studio-api/pause-job"},{"title":"Resume a Scraper Studio job","sidebarTitle":"Resume job","openapi":"api-reference/web-scraper-ide-rest-api POST /dca/jobs/{job_id}/resume","href":"/api-reference/scraper-studio-api/resume-job"},{"title":"Cancel a Scraper Studio job","sidebarTitle":"Cancel job","openapi":"api-reference/web-scraper-ide-rest-api POST /dca/jobs/{job_id}/cancel","href":"/api-reference/scraper-studio-api/cancel-job"},{"title":"Rerun a Scraper Studio job","sidebarTitle":"Rerun job","openapi":"api-reference/web-scraper-ide-rest-api POST /dca/jobs/{job_id}/rerun","href":"/api-reference/scraper-studio-api/rerun-job"}]},{"group":"Manage scrapers \u0026 jobs","pages":[{"title":"List Scraper Studio scrapers","sidebarTitle":"Scrapers","openapi":"api-reference/web-scraper-ide-rest-api GET /dca/collectors_list","href":"/api-reference/scraper-studio-api/list-scrapers"},{"title":"List Scraper Studio jobs","sidebarTitle":"Jobs","openapi":"api-reference/web-scraper-ide-rest-api GET /dca/collector/jobs","href":"/api-reference/scraper-studio-api/list-jobs"},{"title":"Delete a Scraper Studio scraper","sidebarTitle":"Delete scraper","openapi":"api-reference/web-scraper-ide-rest-api DELETE /dca/collector/{scraper_id}","href":"/api-reference/scraper-studio-api/delete-scraper"}]},{"group":"AI flow APIs","pages":[{"title":"Create scraper template","openapi":"api-reference/web-scraper-ide-rest-api POST /dca/collector","href":"/api-reference/scraper-studio-api/ai-flow/create-scraper-template"},{"title":"Trigger AI Flow","openapi":"api-reference/web-scraper-ide-rest-api POST /dca/collectors/{collector_id}/automate_template","href":"/api-reference/scraper-studio-api/ai-flow/trigger-ai-flow"},{"title":"AI job progress","openapi":"api-reference/web-scraper-ide-rest-api GET /dca/collectors/{collector_id}/automate_template/progress","href":"/api-reference/scraper-studio-api/ai-flow/ai-job-progress"},{"title":"Trigger Self-Healing","openapi":"api-reference/web-scraper-ide-rest-api POST /dca/collectors/{collector_id}/refactor_template","href":"/api-reference/scraper-studio-api/ai-flow/trigger-self-healing"},{"title":"Self-Healing Job Progress","openapi":"api-reference/web-scraper-ide-rest-api GET /dca/collectors/{collector_id}/refactor_template/progress","href":"/api-reference/scraper-studio-api/ai-flow/self-healing-job-progress"},{"title":"Resume Self-Healing Job","openapi":"api-reference/web-scraper-ide-rest-api POST /dca/collectors/{collector_id}/resume_automation_job","href":"/api-reference/scraper-studio-api/ai-flow/resume-self-healing-job"},{"title":"Cancel Self-Healing Job","openapi":"api-reference/web-scraper-ide-rest-api POST /dca/collectors/{collector_id}/cancel_automation","href":"/api-reference/scraper-studio-api/ai-flow/cancel-self-healing-job"},{"title":"Enable Auto Self-Healing","openapi":"api-reference/web-scraper-ide-rest-api POST /dca/auto_self_healing/create","href":"/api-reference/scraper-studio-api/ai-flow/enable-auto-self-healing"}]}]},{"group":"Dataset Marketplace API","pages":[{"title":"Dataset list","openapi":"api-reference/dca-api GET /datasets/list","href":"/api-reference/marketplace-dataset-api/get-dataset-list"},{"title":"Get dataset metadata","openapi":"api-reference/dca-api GET /datasets/{dataset_id}/metadata","href":"/api-reference/marketplace-dataset-api/get-dataset-metadata"},{"title":"Filter dataset","openapi":"api-reference/dca-api POST /datasets/filter","href":"/api-reference/marketplace-dataset-api/filter-dataset"},{"title":"Get snapshot metadata","openapi":"api-reference/dca-api GET /datasets/snapshots/{id}","href":"/api-reference/marketplace-dataset-api/get-snapshot-meta"},{"title":"Get snapshot parts","openapi":"api-reference/dca-api GET /datasets/snapshots/{id}/parts","href":"/api-reference/marketplace-dataset-api/get-snapshot-parts"},{"title":"Snapshot content","description":"Use the Bright Data Marketplace Dataset API to download Snapshot Content. GET /datasets/snapshots/{id}/download returns 200 OK with metadata as JSON.","openapi":"api-reference/dca-api GET /datasets/snapshots/{id}/download","href":"/api-reference/marketplace-dataset-api/download-the-file-by-snapshot_id"},{"title":"Deliver snapshot","openapi":"api-reference/dca-api POST /datasets/snapshots/{id}/deliver","href":"/api-reference/marketplace-dataset-api/deliver-snapshot"},{"group":"Delivery settings","pages":[{"title":"Get delivery options","sidebarTitle":"Get delivery options","description":"List the supported delivery destinations, filename templates and batch settings you can use when configuring delivery for a dataset view. Covers 250+ domains.","openapi":"api-reference/dca-api GET /datasets/delivery_settings/options","href":"/api-reference/marketplace-dataset-api/get-delivery-options"},{"title":"Get destination type schema","sidebarTitle":"Get destination schema","openapi":"api-reference/dca-api GET /datasets/delivery_settings/{destination_type}/schema","href":"/api-reference/marketplace-dataset-api/get-destination-type-schema"},{"title":"Get dataset views","sidebarTitle":"Get dataset views","openapi":"api-reference/dca-api GET /datasets/views","href":"/api-reference/marketplace-dataset-api/get-dataset-views"},{"title":"Get view delivery settings","sidebarTitle":"Get view delivery settings","openapi":"api-reference/dca-api GET /datasets/views/{view_id}/delivery_settings","href":"/api-reference/marketplace-dataset-api/get-view-delivery-settings"},{"title":"Update view delivery settings","sidebarTitle":"Update view delivery settings","openapi":"api-reference/dca-api PUT /datasets/views/{view_id}/delivery_settings","href":"/api-reference/marketplace-dataset-api/update-view-delivery-settings"},{"title":"Bulk update view delivery settings","sidebarTitle":"Bulk update delivery settings","openapi":"api-reference/dca-api PUT /datasets/views/delivery_settings/bulk","href":"/api-reference/marketplace-dataset-api/bulk-update-view-delivery-settings"}]}]},{"group":"Web Unlocker API","pages":[{"title":"Web Unlocker API","sidebarTitle":"Web Unlocker API","openapi":"api-reference/unlocker-rest-api POST /request","href":"/api-reference/rest-api/unlocker/unlock-website"},{"title":"Unlocker async request","sidebarTitle":"Request","openapi":"async-api-reference POST /unblocker/req","tag":"Async","href":"/api-reference/rest-api/unlocker/request"},{"title":"Unlocker async response","sidebarTitle":"Response","openapi":"async-api-reference GET /unblocker/get_result","tag":"Async","href":"/api-reference/rest-api/unlocker/get-results"},{"title":"Web Unlocker API success rate","sidebarTitle":"Success rate","openapi":"api-reference/unlocker-rest-api GET /unblocker/success_rate/{domain}","href":"/api-reference/rest-api/unlocker/get-success-rate"}]},{"group":"Browser API","pages":[{"title":"Get browser session","openapi":"GET /browser_sessions/{session_id}","href":"/api-reference/browser-api/get-session"},{"title":"List browser session","openapi":"GET /browser_sessions","href":"/api-reference/browser-api/get-sessions"}]},{"group":"SERP API","pages":[{"title":"SERP API","openapi":"api-reference/serp-rest-api POST /request","href":"/api-reference/rest-api/serp/serp-api"},{"title":"SERP async request","sidebarTitle":"Request","openapi":"async-api-reference POST /serp/req","tag":"Async","href":"/api-reference/rest-api/serp/request"},{"title":"SERP async response","sidebarTitle":"Response","openapi":"async-api-reference GET /serp/get_result","tag":"Async","href":"/api-reference/rest-api/serp/get-results"},{"group":"Google Search","pages":[{"title":"Google Search text search","sidebarTitle":"Text search","href":"/api-reference/serp/google-search/text-search"},{"title":"Google Search localization","sidebarTitle":"Localization","href":"/api-reference/serp/google-search/localization"},{"title":"Image search","sidebarTitle":"Images","href":"/api-reference/serp/google-search/images"},{"title":"Shopping search","sidebarTitle":"Shopping","href":"/api-reference/serp/google-search/shopping"},{"title":"News search","sidebarTitle":"News","href":"/api-reference/serp/google-search/news"},{"title":"Video search","sidebarTitle":"Videos","href":"/api-reference/serp/google-search/videos"},{"title":"Short videos","href":"/api-reference/serp/google-search/short-videos"},{"title":"Job search","sidebarTitle":"Jobs","href":"/api-reference/serp/google-search/jobs"},{"title":"Hotel","href":"/api-reference/serp/google-search/hotel"},{"title":"Search by image","href":"/api-reference/serp/google-search/search-by-image"},{"title":"Google Search pagination","sidebarTitle":"Pagination","href":"/api-reference/serp/google-search/pagination"},{"title":"Geo-location","href":"/api-reference/serp/google-search/geo-location"},{"title":"Google Search parsed JSON","sidebarTitle":"Parsed JSON","href":"/api-reference/serp/google-search/parsed-json"},{"title":"Device (mobile/desktop)","href":"/api-reference/serp/google-search/device-mobile"},{"title":"Device (platform)","href":"/api-reference/serp/google-search/device-ios"},{"title":"Browser type","sidebarTitle":"Browser","href":"/api-reference/serp/google-search/browser"},{"title":"Multiple requests","href":"/api-reference/serp/google-search/multiple-requests"},{"title":"AI overview","href":"/api-reference/serp/google-search/ai-overview"},{"title":"Asynchronous requests","url":"/api-reference/rest-api/serp/request","href":"/api-reference/serp/google-search/async"}]},{"group":"Google Maps","pages":[{"title":"Google Maps text search","sidebarTitle":"Text search","href":"/api-reference/serp/google-maps/text-search"},{"title":"Google Maps localization","sidebarTitle":"Localization","href":"/api-reference/serp/google-maps/localization"},{"title":"Coordinates","href":"/api-reference/serp/google-maps/coordinates"},{"title":"Google Maps pagination","sidebarTitle":"Pagination","href":"/api-reference/serp/google-maps/pagination"},{"title":"Place details","href":"/api-reference/serp/google-maps/place-details"},{"title":"Filtering","href":"/api-reference/serp/google-maps/filtering"},{"title":"Google Maps parsed JSON","sidebarTitle":"Parsed JSON","href":"/api-reference/serp/google-maps/parsed-json"},{"title":"Google Maps async request","sidebarTitle":"Async","href":"/api-reference/serp/google-maps/async"}]},{"group":"Google Trends","pages":[{"title":"Google Trends text search","sidebarTitle":"Text Search","href":"/api-reference/serp/google-trends/text-search"},{"title":"Geo","href":"/api-reference/serp/google-trends/geo"},{"title":"Google Trends localization","sidebarTitle":"Localization","href":"/api-reference/serp/google-trends/localization"},{"title":"Time range","href":"/api-reference/serp/google-trends/time-range"},{"title":"Category","href":"/api-reference/serp/google-trends/category"},{"title":"Search type","href":"/api-reference/serp/google-trends/search-type"},{"title":"Google Trends async request","sidebarTitle":"Async","href":"/api-reference/serp/google-trends/async"}]},{"group":"Google Reviews","pages":[{"title":"Google Reviews text search","sidebarTitle":"Text search","href":"/api-reference/serp/google-reviews/text-search"},{"title":"Google Reviews localization","sidebarTitle":"Localization","href":"/api-reference/serp/google-reviews/localization"},{"title":"Sort (newest)","href":"/api-reference/serp/google-reviews/sort-newest"},{"title":"Sort (highest)","href":"/api-reference/serp/google-reviews/sort-highest"},{"title":"Sort (lowest)","href":"/api-reference/serp/google-reviews/sort-lowest"},{"title":"Filter by keyword","sidebarTitle":"Filter","href":"/api-reference/serp/google-reviews/filter-keyword"},{"title":"Google Reviews pagination","sidebarTitle":"Pagination","href":"/api-reference/serp/google-reviews/pagination"},{"title":"Google Reviews async request","sidebarTitle":"Async","href":"/api-reference/serp/google-reviews/async"}]},{"group":"Google Lens","pages":[{"title":"Image URL","href":"/api-reference/serp/google-lens/image-url"},{"title":"Google Lens localization","sidebarTitle":"Localization","href":"/api-reference/serp/google-lens/localization"},{"title":"Geo location","href":"/api-reference/serp/google-lens/geo-location"},{"title":"Google Lens parsed JSON","sidebarTitle":"Parsed JSON","href":"/api-reference/serp/google-lens/parsed-json"},{"title":"Exact matches","href":"/api-reference/serp/google-lens/exact-matches"},{"title":"Visual matches","href":"/api-reference/serp/google-lens/visual-matches"},{"title":"Products","href":"/api-reference/serp/google-lens/products"},{"title":"Homework","href":"/api-reference/serp/google-lens/homework"},{"title":"Upload file","href":"/api-reference/serp/google-lens/upload-file"},{"title":"Google Lens async request","sidebarTitle":"Async","href":"/api-reference/serp/google-lens/async"}]},{"group":"Google Hotels","pages":[{"title":"Google Hotels text search","sidebarTitle":"Text Search","href":"/api-reference/serp/google-hotels/text-search"},{"title":"Google Hotels localization","sidebarTitle":"Localization","href":"/api-reference/serp/google-hotels/localization"},{"title":"Dates","href":"/api-reference/serp/google-hotels/dates"},{"title":"Occupancy","href":"/api-reference/serp/google-hotels/occupancy"},{"title":"Occupancy (children)","href":"/api-reference/serp/google-hotels/occupancy-children"},{"title":"Free cancellation","href":"/api-reference/serp/google-hotels/free-cancellation"},{"title":"Accommodation type","href":"/api-reference/serp/google-hotels/accommodation-type"},{"title":"Google Hotels currency","sidebarTitle":"Currency","href":"/api-reference/serp/google-hotels/currency"},{"title":"Device type","href":"/api-reference/serp/google-hotels/device-type"},{"title":"Google Hotels parsed JSON","sidebarTitle":"Parsed JSON","href":"/api-reference/serp/google-hotels/parsed-json"},{"title":"Google Hotels async request","sidebarTitle":"Async","href":"/api-reference/serp/google-hotels/async"}]},{"group":"Google Flights","pages":[{"title":"Google Flights text search","sidebarTitle":"Text Search","href":"/api-reference/serp/google-flights/text-search"},{"title":"Google Flights localization","sidebarTitle":"Localization","href":"/api-reference/serp/google-flights/localization"},{"title":"Complex search","href":"/api-reference/serp/google-flights/complex-search"},{"title":"Google Flights currency","sidebarTitle":"Currency","href":"/api-reference/serp/google-flights/currency"},{"title":"Google Flights async request","sidebarTitle":"Async","href":"/api-reference/serp/google-flights/async"}]}]}]},{"group":"Web search","pages":[{"group":"Business Search API","pages":[{"title":"Business Search API: search companies","sidebarTitle":"Search companies","openapi":"api-reference/business-search/business-search-api POST /search/company","href":"/api-reference/business-search/search-company"},{"title":"Business Search API: search people","sidebarTitle":"Search people","openapi":"api-reference/business-search/business-search-api POST /search/people","href":"/api-reference/business-search/search-people"}]}]},{"group":"AI training data","pages":[{"group":"Web Archive API","pages":[{"title":"Run a search","openapi":"api-reference/web-archive-api POST /webarchive/search","href":"/api-reference/archive-api/run-a-search"},{"title":"Get search status","openapi":"api-reference/web-archive-api GET /webarchive/search/{search_id}","href":"/api-reference/archive-api/get-search-status"},{"title":"Deliver snapshot to S3, Azure Blob or GCP","sidebarTitle":"Deliver to Cloud","openapi":"api-reference/web-archive-api POST /webarchive/dump","href":"/api-reference/archive-api/deliver-to-cloud"},{"title":"Get status of data snapshot","sidebarTitle":"Get Snapshot Status","openapi":"api-reference/web-archive-api GET /webarchive/dump/{dump_id}","href":"/api-reference/archive-api/get-snapshot-status"},{"title":"Export metadata","sidebarTitle":"Export metadata","openapi":"api-reference/web-archive-api POST /webarchive/dump_metadata","href":"/api-reference/archive-api/export-metadata"},{"group":"Get All Statuses","pages":[{"title":"Get all search statuses","sidebarTitle":"All Search Statuses","openapi":"api-reference/web-archive-api GET /webarchive/searches","href":"/api-reference/archive-api/get-all-search-statuses"},{"title":"Get the statuses of all data snapshots","sidebarTitle":"All Snapshots Statuses","openapi":"api-reference/web-archive-api GET /webarchive/dumps","href":"/api-reference/archive-api/get-all-snapshots-statuses"}]}]},{"group":"Media Data API","pages":[{"title":"Media Data API","openapi":"api-reference/media-data-api/media-data-api POST /dca/trigger_hp","hideApiMarker":true,"href":"/api-reference/media-data-api/media-data-api"},{"title":"Get Media Data API job errors","sidebarTitle":"Job errors","openapi":"api-reference/media-data-api/media-data-api GET /dca/jobs/{job_id}/hp_errors","href":"/api-reference/media-data-api/get-errors-for-job"}]}]},{"group":"Proxy","pages":[{"group":"Proxy Networks","pages":[{"title":"Proxy geolocation targeting","href":"/api-reference/proxy/geolocation-targeting"},{"title":"Request and response C-Tag","href":"/api-reference/proxy/c-tag"},{"title":"Proxy and IP rotation control","href":"/api-reference/proxy/rotate_ips"},{"title":"Disable peer rotation","sidebarTitle":"Disable peer rotation","href":"/api-reference/proxy/keep_same_peer_in_session"},{"title":"Select super proxy by country","href":"/api-reference/proxy/select_super_proxy_in_specific_country"},{"title":"Configuring DNS resolution","href":"/api-reference/proxy/configuring_dns_resolution"},{"title":"Request error handling","href":"/api-reference/proxy/request_error_handling"},{"title":"Send requests directly from super proxy","href":"/api-reference/proxy/send_requests_directly_from_super_proxy"},{"title":"OS targeting","href":"/api-reference/proxy/os_targeting"},{"title":"Select a specific gIP","href":"/api-reference/proxy/select_a_specific_gip"},{"title":"Select a specific IP","href":"/api-reference/proxy/select_a_specific_ip"}]},{"group":"Proxy Manager API","pages":[{"group":"Installation \u0026 versions","pages":[{"title":"Get the latest Proxy Manager (PM) version","sidebarTitle":"Get latest PM version","href":"/api-reference/proxy-manager/get_the_latest_proxy_manager_versions"},{"title":"Get Proxy Manager version","href":"/api-reference/proxy-manager/get_proxy_manager_version"},{"title":"Upgrade Proxy Manager","href":"/api-reference/proxy-manager/upgrade_proxy_manager"},{"title":"Get current NodeJS version","href":"/api-reference/proxy-manager/get_currently_running_nodejs_version"},{"title":"Restart Proxy Manager","href":"/api-reference/proxy-manager/restart_proxy_manager"},{"title":"Shutdown Proxy Manager","href":"/api-reference/proxy-manager/shutdown_proxy_manager"}]},{"group":"Users \u0026 access","pages":[{"title":"Add a user","href":"/api-reference/proxy-manager/add_a_user"},{"title":"Get all users","href":"/api-reference/proxy-manager/get_all_users"},{"title":"Allowlist IPs","href":"/api-reference/proxy-manager/allowlist-ips"},{"title":"Allowlist IPs to access UI","href":"/api-reference/proxy-manager/ui-allowlist-ips"},{"title":"Generate API key","href":"/api-reference/proxy-manager/generate_token_for_token_based_authentication"}]},{"group":"Settings \u0026 configuration","pages":[{"title":"Get general settings","href":"/api-reference/proxy-manager/get_general_settings"},{"title":"Update general setting","href":"/api-reference/proxy-manager/update_general_settings"},{"title":"Get explicit config of proxies","href":"/api-reference/proxy-manager/get_explicit_configuration_of_all_or_specified_proxies"},{"title":"Get effective config of running proxies","sidebarTitle":"Get effective configuration","href":"/api-reference/proxy-manager/get_effective_configuration_for_all_running_proxies"},{"title":"Get enabled zone's configuration","sidebarTitle":"Get enabled Zone's Config","href":"/api-reference/proxy-manager/get_enabled_zones_configuration"}]},{"group":"Proxy ports","pages":[{"title":"Create new proxy port","href":"/api-reference/proxy-manager/create_a_new_proxy_port"},{"title":"Delete proxy ports (multiple)","href":"/api-reference/proxy-manager/delete_proxy_ports"},{"title":"Delete a proxy port","href":"/api-reference/proxy-manager/delete_a_proxy_port"},{"title":"Update a proxy port","href":"/api-reference/proxy-manager/update_a_proxy_port"},{"title":"Get proxy port status","href":"/api-reference/proxy-manager/get_proxy_port_status"},{"title":"Refresh Proxy Manager port session","sidebarTitle":"Refresh PM Port Sesson","href":"/api-reference/proxy-manager/refresh_proxy_manager_port_sessions"},{"title":"Enable SSL analyzing (all ports)","href":"/api-reference/proxy-manager/enable_ssl_analyzing_on_all_proxy_ports"}]},{"group":"IPs \u0026 sessions","pages":[{"title":"Get allocated gIPs in a zone","sidebarTitle":"Get allocated gIPs","href":"/api-reference/proxy-manager/get_allocated_gips_in_zone"},{"title":"Get allocated IPs in a zone","sidebarTitle":"Get allocated IPs","href":"/api-reference/proxy-manager/get_allocated_ips_in_zone"},{"title":"Refresh IP/gIP in a zone","sidebarTitle":"Refresh IP/gIP","href":"/api-reference/proxy-manager/refresh_ips_or_gips_in_zone"}]},{"group":"IP bans","pages":[{"title":"Ban an IP","href":"/api-reference/proxy-manager/ban_an_ip_single_"},{"title":"Ban multiple IPs (array)","href":"/api-reference/proxy-manager/ban_ips_array_"},{"title":"Ban an IP (all ports)","href":"/api-reference/proxy-manager/ban_an_ip_for_all_ports"},{"title":"Unban an IP","href":"/api-reference/proxy-manager/unban_an_ip"},{"title":"Unban IPs (multiple)","href":"/api-reference/proxy-manager/unban_ips"},{"title":"Get banned IPs","href":"/api-reference/proxy-manager/get_banned_ips"}]},{"group":"Logs \u0026 stats","pages":[{"title":"Get recent status","href":"/api-reference/proxy-manager/get_recent_stats"},{"title":"Get HAR logs","href":"/api-reference/proxy-manager/get_har_logs"},{"title":"Get tail from the log file","href":"/api-reference/proxy-manager/get_tail_from_the_log_file"}]}]}]},{"group":"Administrative APIs","pages":[{"group":"Account Management API","pages":[{"group":"Account \u0026 status","pages":[{"title":"Change account status","openapi":"api-reference/openapi PUT /status","href":"/api-reference/account-management-api/Change_account_status"},{"title":"Account status","openapi":"api-reference/openapi GET /status","href":"/api-reference/account-management-api/Get_account_status"},{"title":"Get current service status","openapi":"api-reference/openapi GET /network_status/{NETWORK_TYPE}","href":"/api-reference/account-management-api/Get_current_service_status"},{"title":"Cost breakdown export","sidebarTitle":"Cost breakdown export","openapi":"api-reference/openapi POST /costs/export/json","href":"/api-reference/account-management-api/Export_cost_breakdown"},{"title":"Get free tier credits","sidebarTitle":"Free tier credits","openapi":"api-reference/openapi GET /trials/free_tier","href":"/api-reference/account-management-api/Get_free_tier_credits"},{"title":"Get pricing plans","sidebarTitle":"Pricing plans","openapi":"api-reference/openapi GET /pricing_plans","href":"/api-reference/account-management-api/Get_pricing_plans"},{"title":"Total balance","openapi":"api-reference/openapi GET /customer/balance","href":"/api-reference/account-management-api/Get_total_balance_through_API"},{"title":"Get payment methods","sidebarTitle":"Payment methods","openapi":"api-reference/openapi GET /billing/pmethods","href":"/api-reference/account-management-api/Get_payment_methods"},{"title":"Get auto-recharge settings","sidebarTitle":"Auto-recharge settings","openapi":"api-reference/openapi GET /billing/autorecharge","href":"/api-reference/account-management-api/Get_auto_recharge_settings"},{"title":"Set regular auto-recharge","sidebarTitle":"Set regular auto-recharge","openapi":"api-reference/openapi PUT /billing/autorecharge/regular","href":"/api-reference/account-management-api/Set_regular_auto_recharge"},{"title":"Set dataset auto-recharge","sidebarTitle":"Set dataset auto-recharge","openapi":"api-reference/openapi PUT /billing/autorecharge/dataset","href":"/api-reference/account-management-api/Set_dataset_auto_recharge"}]},{"group":"Zones","pages":[{"title":"Add a zone","openapi":"api-reference/openapi POST /zone","href":"/api-reference/account-management-api/Add_a_Zone"},{"title":"Active zones","openapi":"api-reference/openapi GET /zone/get_active_zones","href":"/api-reference/account-management-api/Get_active_Zones"},{"title":"All zones","openapi":"api-reference/openapi GET /zone/get_all_zones","href":"/api-reference/account-management-api/get-all-zones"},{"title":"Zone info","openapi":"api-reference/openapi GET /zone","href":"/api-reference/account-management-api/Get_Zone_info"},{"title":"Zone permission","openapi":"api-reference/openapi GET /zone/permissions","href":"/api-reference/account-management-api/Get_Zone_permissions"},{"title":"Zone status","openapi":"api-reference/openapi GET /zone/status","href":"/api-reference/account-management-api/Get_Zone_status"},{"title":"Remove a zone","openapi":"api-reference/openapi DELETE /zone","href":"/api-reference/account-management-api/Remove_Zone"},{"title":"Switch automatic failover","openapi":"api-reference/openapi POST /zone/switch_100uptime","href":"/api-reference/account-management-api/Switch_100_uptime_ON_OFF_in_a_Static_zone"},{"title":"Turn on/off zone","openapi":"api-reference/openapi POST /zone/change_disable","href":"/api-reference/account-management-api/Turn_on_off_Zone"}]},{"group":"Zone passwords","pages":[{"title":"Zone password","openapi":"api-reference/openapi GET /zone/passwords","href":"/api-reference/account-management-api/Get_Zone_passwords"},{"title":"Add zone password","openapi":"api-reference/openapi POST /zone/add_password","href":"/api-reference/account-management-api/add-zone-password"},{"title":"Remove zone password","openapi":"api-reference/openapi POST /zone/remove_password","href":"/api-reference/account-management-api/remove-zone-password"}]},{"group":"Allowlists \u0026 denylists","pages":[{"title":"Allowlist/denylist domain(s)","sidebarTitle":"Allow/Deny Domains","openapi":"api-reference/openapi POST /zone/domain_perm","href":"/api-reference/account-management-api/allowlist-or-denylist-domains"},{"title":"Denylist IP(s)","openapi":"api-reference/openapi POST /zone/blacklist","href":"/api-reference/account-management-api/denylist-ip"},{"title":"Allowlist IP(s)","openapi":"api-reference/openapi POST /zone/whitelist","href":"/api-reference/account-management-api/allowlist-ip"},{"title":"List of denylisted IPs for a zone","openapi":"api-reference/openapi GET /zone/blacklist","href":"/api-reference/account-management-api/zone-ip-denylist"},{"title":"List of allowlisted IPs for a zone","openapi":"api-reference/openapi GET /zone/whitelist","href":"/api-reference/account-management-api/zone-ip-allowlist"},{"title":"Remove domain from allow/denylist","openapi":"api-reference/openapi DELETE /zone/domain_perm","href":"/api-reference/account-management-api/remove-domain-from-zone-allowlist-or-denylist"},{"title":"Remove IP from zone denylist","openapi":"api-reference/openapi DELETE /zone/blacklist","href":"/api-reference/account-management-api/remove-ip-from-zone-denylist"},{"title":"Remove IP from zone allowlist","openapi":"api-reference/openapi DELETE /zone/whitelist","href":"/api-reference/account-management-api/remove-ip-from-zone-allowlist"}]},{"group":"Static IPs","pages":[{"title":"Add static IP(s)","openapi":"api-reference/openapi POST /zone/ips","href":"/api-reference/account-management-api/Add_Static_Datacenter_ISP_IPs"},{"title":"Migrate static IPs between zones","sidebarTitle":"Migrate Static IPs","openapi":"api-reference/openapi POST /zone/ips/migrate","href":"/api-reference/account-management-api/Migrate_Static_Datacenter_ISP_IPs_between_zones"},{"title":"Refresh static IPs (Datacenter/ISP)","openapi":"api-reference/openapi POST /zone/ips/refresh","href":"/api-reference/account-management-api/Refresh_Static_Datacenter_ISP_IPs"},{"title":"Available Datacenter and ISP IPs","sidebarTitle":"Available Datacenter \u0026 ISP IPs count","openapi":"api-reference/openapi GET /zone/count_available_ips","href":"/api-reference/account-management-api/Get_amount_of_available_Datacenter_and_ISP_IPs"},{"title":"Available Datacenter \u0026 ISP IPs/zone","openapi":"api-reference/openapi GET /zone/route_ips","href":"/api-reference/account-management-api/Get_the_available_Data_center_ISP_IPs_per_Zone"},{"title":"Live status of static zone","openapi":"api-reference/openapi GET /zone/ips/unavailable","href":"/api-reference/account-management-api/Get_live_status_of_Static_Datacenter_ISP_Zone_and_IPs_with_connectivity_problem"},{"title":"Zone statistics","openapi":"api-reference/openapi GET /zone/ips","href":"/api-reference/account-management-api/Get_Zone_Static_Datacenter_ISP_IPs"},{"title":"Get proxies pending replacement","openapi":"api-reference/openapi GET /zone/proxies_pending_replacement","href":"/api-reference/account-management-api/get-proxies-pending-replacement"},{"title":"Remove static IPs (Datacenter/ISP)","openapi":"api-reference/openapi DELETE /zone/ips","href":"/api-reference/account-management-api/Remove_Static_Datacenter_ISP_IPs"}]},{"group":"Residential IPs","pages":[{"title":"Refresh dedicated residential IPs","openapi":"api-reference/openapi POST /zone/ips/refresh","href":"/api-reference/account-management-api/Refresh_dedicated_residential_IPs"},{"title":"Get available dedicated IPs per zone","sidebarTitle":"Available IPs/Zone","openapi":"api-reference/openapi GET /zone/route_vips","href":"/api-reference/account-management-api/Get_all_available_dedicated_residential_IPs_per_Zone"},{"title":"Remove dedicated residential IPs","openapi":"api-reference/openapi DELETE /zone/vips","href":"/api-reference/account-management-api/Remove_dedicated_residential_IPs"}]},{"group":"Geo data","pages":[{"title":"Get account available countries","sidebarTitle":"Get Countries","openapi":"api-reference/openapi GET /countrieslist","href":"/api-reference/account-management-api/Get_Available_Countries"},{"title":"Get country cities","openapi":"api-reference/openapi GET /cities","href":"/api-reference/account-management-api/Get_country_cities"},{"title":"List static network cities by country","openapi":"api-reference/openapi GET /zone/static/cities","href":"/api-reference/account-management-api/Get_list_of_available_cities_of_static_network_per_country"}]},{"group":"Stats \u0026 usage","pages":[{"title":"Recent IPs attempting to use your zone","openapi":"api-reference/openapi GET /zone/recent_ips","href":"/api-reference/account-management-api/Get_recent_IPs_attempting_to_use_your_Zone"},{"title":"Bandwidth stats for a zone","openapi":"api-reference/openapi GET /zone/bw","href":"/api-reference/account-management-api/Get_the_bandwidth_stats_for_a_Zone"},{"title":"Bandwidth stats for all your zones","openapi":"api-reference/openapi GET /customer/bw","href":"/api-reference/account-management-api/Get_the_bandwidth_stats_for_all_your_Zones"},{"title":"Total cost \u0026 bandwidth for a zone","openapi":"api-reference/openapi GET /zone/cost","href":"/api-reference/account-management-api/Get_the_total_cost_and_bandwidth_stats_for_a_Zone"},{"title":"Domain consumption","openapi":"api-reference/proxy-manager GET /domains/{metric}","href":"/api-reference/account-management-api/domain-consumption"}]}]}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/introduction"}]},{"tab":"Account Management","pages":[{"title":"Account Management","href":"/general/account/overview"}]},{"tab":"Left over","hidden":true,"pages":[{"title":"Left over","href":"/left-over/datasets-introduction"}]}]},{"language":"cn","pages":[{"title":"cn","href":"/cn/api-reference/marketplace-dataset-api/deliver-snapshot"}]}]},"basePath":"","title":"Deliver snapshot - Bright Data Docs","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}