[{"data":1,"prerenderedAt":797},["ShallowReactive",2],{"sdk-docs-navigation":3,"sdk-docs-page:\u002Fgscdump-sdk\u002Fapi\u002Fhosted-http":112},[4],{"path":5,"title":6,"children":7,"stem":111,"page":16},"\u002Fgscdump-sdk","gscdump SDK",[8,27],{"path":9,"title":10,"children":11,"stem":25,"page":26},"\u002Fgscdump-sdk\u002Fapi","Api",[12,17,21],{"path":13,"title":14,"stem":15,"page":16},"\u002Fgscdump-sdk\u002Fapi\u002Fdirect-client","Direct client exports","api\u002F1.direct-client",true,{"path":18,"title":19,"stem":20,"page":16},"\u002Fgscdump-sdk\u002Fapi\u002Fhosted-http","Hosted HTTP","api\u002F2.hosted-http",{"path":22,"title":23,"stem":24,"page":16},"\u002Fgscdump-sdk\u002Fapi\u002Frealtime","Realtime","api\u002F3.realtime","gscdump-sdk\u002Fapi",false,{"path":28,"title":29,"children":30,"stem":110,"page":26},"\u002Fgscdump-sdk\u002Fguides","Guides",[31,48,73,97],{"path":32,"title":33,"children":34,"stem":47,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fstart","Start",[35,39,43],{"path":36,"title":37,"stem":38,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fstart\u002Fchoose-access","Choose access","guides\u002F1.start\u002F1.choose-access",{"path":40,"title":41,"stem":42,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fstart\u002Fhosted-first-result","Hosted first result","guides\u002F1.start\u002F2.hosted-first-result",{"path":44,"title":45,"stem":46,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fstart\u002Fdirect-first-result","Direct first result","guides\u002F1.start\u002F3.direct-first-result","guides\u002F1.start\u002Findex",{"path":49,"title":50,"children":51,"stem":72,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fread-data","Read data",[52,56,60,64,68],{"path":53,"title":54,"stem":55,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fread-data\u002Fdirect-search-analytics","Direct Search Analytics","guides\u002F2.read-data\u002F1.direct-search-analytics",{"path":57,"title":58,"stem":59,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fread-data\u002Fhosted-analytics","Hosted analytics","guides\u002F2.read-data\u002F2.hosted-analytics",{"path":61,"title":62,"stem":63,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fread-data\u002Fhosted-indexing","Hosted indexing","guides\u002F2.read-data\u002F3.hosted-indexing",{"path":65,"title":66,"stem":67,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fread-data\u002Fhosted-sitemaps","Hosted sitemaps","guides\u002F2.read-data\u002F4.hosted-sitemaps",{"path":69,"title":70,"stem":71,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fread-data\u002Fdirect-bing","Direct Bing","guides\u002F2.read-data\u002F5.direct-bing","guides\u002F2.read-data\u002Findex",{"path":74,"title":75,"children":76,"stem":96,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fbuild-integrations","Build integrations",[77,81,85,89,92],{"path":78,"title":79,"stem":80,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fbuild-integrations\u002Fnuxt","Nuxt","guides\u002F3.build-integrations\u002F1.nuxt",{"path":82,"title":83,"stem":84,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fbuild-integrations\u002Fnextjs","Next.js","guides\u002F3.build-integrations\u002F2.nextjs",{"path":86,"title":87,"stem":88,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fbuild-integrations\u002Fhono-express","Hono \u002F Express","guides\u002F3.build-integrations\u002F3.hono-express",{"path":90,"title":23,"stem":91,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fbuild-integrations\u002Frealtime","guides\u002F3.build-integrations\u002F4.realtime",{"path":93,"title":94,"stem":95,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Fbuild-integrations\u002Fwebhooks","Webhooks","guides\u002F3.build-integrations\u002F5.webhooks","guides\u002F3.build-integrations\u002Findex",{"path":98,"title":99,"children":100,"stem":109,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Foperate","Operate",[101,105],{"path":102,"title":103,"stem":104,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Foperate\u002Fkeys-and-scopes","Keys and scopes","guides\u002F4.operate\u002F1.keys-and-scopes",{"path":106,"title":107,"stem":108,"page":16},"\u002Fgscdump-sdk\u002Fguides\u002Foperate\u002Ferrors-and-retry","Errors and retry","guides\u002F4.operate\u002F2.errors-and-retry","guides\u002F4.operate\u002Findex","gscdump-sdk\u002Fguides","index",{"title":19,"description":113,"body":114,"id":792,"path":18,"stem":20,"extension":793,"seo":794,"_source":795,"sitemap":796},"Call typed v1 operations and handle API errors, rate limits, and retries.",{"toc":115,"nodes":132,"frontmatter":783,"meta":784},{"links":116,"title":130,"searchDepth":131,"depth":131},[117,121,124,127],{"id":118,"text":119,"depth":120},"api-specifications","API specifications",2,{"id":122,"text":123,"depth":120},"errors","Errors",{"id":125,"text":126,"depth":120},"rate-limits","Rate limits",{"id":128,"text":129,"depth":120},"idempotency-and-retries","Idempotency and retries","",3,[133,137,154,157,160,163,189,331,334,336,339,410,432,643,650,675,677,680,704,710,712,719,725,759,762,776],[134,135,19],"h1",{"id":136},"hosted-http",[138,139,140,141,145,146,149,150,153],"p",{},"Import ",[142,143,144],"code",{},"createGscdumpV1Client"," from ",[142,147,148],{},"@gscdump\u002Fsdk\u002Fv1",".\nEach registered operation has a typed convenience method.\nYou can also pass its operation ID to ",[142,151,152],{},"client.execute()",".",[138,155,156],{},"The client validates request and response payloads against the generated contracts.",[158,159,119],"h2",{"id":118},[138,161,162],{},"Generate OpenAPI and AsyncAPI documents from the published contracts package:",[164,165,169],"pre",{"language":166,"class":167,"tabindex":168},"bash","rangi shiki shj-lang-bash",0,[142,170,172],{"class":171},"language-bash",[173,174,177,182,183,188],"span",{"class":175,"style":176},"line","display: inline",[173,178,181],{"class":179,"style":180},"shj-syn-func shj-func","--shiki-light:#8250df;--shiki-default:#8250df;color:#8250df;--shiki-dark:#d2a8ff","pnpm"," ",[173,184,187],{"class":185,"style":186},"shj-syn-kwd shj-kwd","--shiki-light:#cf222e;--shiki-default:#cf222e;color:#cf222e;--shiki-dark:#ff7b72","add"," @gscdump\u002Fcontracts",[164,190,193],{"language":191,"class":192,"tabindex":168},"ts","rangi shiki shj-lang-ts",[142,194,196,218,219,218,233,218,235,218,287,218,327],{"class":195},"language-ts",[173,197,198,182,201,206,207,182,210,182,213],{"class":175,"style":176},[173,199,200],{"class":185,"style":186},"import",[173,202,205],{"class":203,"style":204},"shj-syn-bracket shj-bracket","--shiki-light:#57606a;--shiki-default:#57606a;color:#57606a;--shiki-dark:#8b949e","{"," writeFile ",[173,208,209],{"class":203,"style":204},"}",[173,211,212],{"class":185,"style":186},"from",[173,214,217],{"class":215,"style":216},"shj-syn-str shj-str","--shiki-light:#0a3069;--shiki-default:#0a3069;color:#0a3069;--shiki-dark:#a5d6ff","'node:fs\u002Fpromises'","\n",[173,220,221,182,223,225,226,182,228,182,230],{"class":175,"style":176},[173,222,200],{"class":185,"style":186},[173,224,205],{"class":203,"style":204}," createGscdumpV1Documents ",[173,227,209],{"class":203,"style":204},[173,229,212],{"class":185,"style":186},[173,231,232],{"class":215,"style":216},"'@gscdump\u002Fcontracts\u002Fv1'",[173,234],{"class":175,"style":176},[173,236,237,182,240,243,182,246,249,250,254,255,182,258,182,261,266,268,271,273,276,278,281,283,182,285],{"class":175,"style":176},[173,238,239],{"class":185,"style":186},"for",[173,241,242],{"class":203,"style":204},"(",[173,244,245],{"class":185,"style":186},"const",[173,247,248],{"class":203,"style":204},"[","name",[173,251,253],{"class":252,"style":186},"shj-syn-oper shj-oper",","," document",[173,256,257],{"class":203,"style":204},"]",[173,259,260],{"class":185,"style":186},"of",[173,262,265],{"class":263,"style":264},"shj-syn-class shj-class","--shiki-light:#953800;--shiki-default:#953800;color:#953800;--shiki-dark:#ffa657","Object",[173,267,153],{"class":252,"style":186},[173,269,270],{"class":179,"style":180},"entries",[173,272,242],{"class":203,"style":204},[173,274,275],{"class":179,"style":180},"createGscdumpV1Documents",[173,277,242],{"class":203,"style":204},[173,279,280],{"class":203,"style":204},")",[173,282,280],{"class":203,"style":204},[173,284,280],{"class":203,"style":204},[173,286,205],{"class":203,"style":204},[173,288,289,290,182,293,296,249,298,182,300,305,307,310,312,313,182,315,318,182,320,323,325],{"class":175,"style":176},"  ",[173,291,292],{"class":185,"style":186},"await",[173,294,295],{"class":179,"style":180},"writeFile",[173,297,242],{"class":203,"style":204},[173,299,253],{"class":252,"style":186},[173,301,304],{"class":302,"style":303},"shj-syn-num shj-num","--shiki-light:#0550ae;--shiki-default:#0550ae;color:#0550ae;--shiki-dark:#79c0ff","JSON",[173,306,153],{"class":252,"style":186},[173,308,309],{"class":179,"style":180},"stringify",[173,311,242],{"class":203,"style":204},"document",[173,314,253],{"class":252,"style":186},[173,316,317],{"class":302,"style":303},"null",[173,319,253],{"class":252,"style":186},[173,321,322],{"class":302,"style":303},"2",[173,324,280],{"class":203,"style":204},[173,326,280],{"class":203,"style":204},[173,328,329],{"class":175,"style":176},[173,330,209],{"class":203,"style":204},[138,332,333],{},"The function returns three OpenAPI documents: partner, analytics, and realtime HTTP.\nIt also returns the realtime AsyncAPI document.\nEach document defines inputs, responses, scopes, and operation semantics for your installed package version.",[158,335,123],{"id":122},[138,337,338],{},"API failures use one JSON envelope:",[164,340,343],{"language":341,"class":342,"tabindex":168},"json","rangi shiki shj-lang-json",[142,344,346,218,350,218,359,218,368,218,376,218,384,218,393,218,402,218,406],{"class":345},"language-json",[173,347,348],{"class":175,"style":176},[173,349,205],{"class":203,"style":204},[173,351,289,352,356,357],{"class":175,"style":176},[173,353,355],{"class":354,"style":303},"shj-syn-var shj-var","\"error\"",": ",[173,358,205],{"class":203,"style":204},[173,360,361,362,356,365,253],{"class":175,"style":176},"    ",[173,363,364],{"class":354,"style":303},"\"code\"",[173,366,367],{"class":215,"style":216},"\"site_not_found\"",[173,369,361,370,356,373,253],{"class":175,"style":176},[173,371,372],{"class":354,"style":303},"\"message\"",[173,374,375],{"class":215,"style":216},"\"Site not found\"",[173,377,361,378,356,381,253],{"class":175,"style":176},[173,379,380],{"class":354,"style":303},"\"requestId\"",[173,382,383],{"class":215,"style":216},"\"req_01\"",[173,385,361,386,356,389,253],{"class":175,"style":176},[173,387,388],{"class":354,"style":303},"\"retryable\"",[173,390,392],{"class":391,"style":303},"shj-syn-bool shj-bool","false",[173,394,361,395,356,398,400],{"class":175,"style":176},[173,396,397],{"class":354,"style":303},"\"details\"",[173,399,205],{"class":203,"style":204},[173,401,209],{"class":203,"style":204},[173,403,289,404],{"class":175,"style":176},[173,405,209],{"class":203,"style":204},[173,407,408],{"class":175,"style":176},[173,409,209],{"class":203,"style":204},[138,411,412,413,415,416,419,420,423,424,427,428,431],{},"Branch on ",[142,414,142],{}," and ",[142,417,418],{},"retryable",". Treat ",[142,421,422],{},"message"," as display text. Include\n",[142,425,426],{},"requestId"," when reporting a failure. The SDK exposes the same fields through\n",[142,429,430],{},"GscdumpV1Error",":",[164,433,434],{"language":191,"class":192,"tabindex":168},[142,435,436,218,442,218,447,218,452,218,461,218,463,218,477,218,501,218,507,218,509,218,528,218,545,218,556,218,581,218,599,218,621,218,628,218,632,218,637],{"class":195},[173,437,438,182,440],{"class":175,"style":176},[173,439,200],{"class":185,"style":186},[173,441,205],{"class":203,"style":204},[173,443,444,445],{"class":175,"style":176},"  createGscdumpV1Client",[173,446,253],{"class":252,"style":186},[173,448,449,450],{"class":175,"style":176},"  isGscdumpV1Error",[173,451,253],{"class":252,"style":186},[173,453,454,182,456,182,458],{"class":175,"style":176},[173,455,209],{"class":203,"style":204},[173,457,212],{"class":185,"style":186},[173,459,460],{"class":215,"style":216},"'@gscdump\u002Fsdk\u002Fv1'",[173,462],{"class":175,"style":176},[173,464,465,467,468,182,471,473,475],{"class":175,"style":176},[173,466,245],{"class":185,"style":186}," gscdump ",[173,469,470],{"class":252,"style":186},"=",[173,472,144],{"class":179,"style":180},[173,474,242],{"class":203,"style":204},[173,476,205],{"class":203,"style":204},[173,478,479,480,182,482,484,182,486,489,490,492,493,495,498],{"class":175,"style":176},"  credential",[173,481,431],{"class":252,"style":186},[173,483,242],{"class":203,"style":204},[173,485,280],{"class":203,"style":204},[173,487,488],{"class":185,"style":186},"=>"," process",[173,491,153],{"class":252,"style":186},"env",[173,494,153],{"class":252,"style":186},[173,496,497],{"class":302,"style":303},"GSCDUMP_API_KEY",[173,499,500],{"class":252,"style":186},"!,",[173,502,503,505],{"class":175,"style":176},[173,504,209],{"class":203,"style":204},[173,506,280],{"class":203,"style":204},[173,508],{"class":175,"style":176},[173,510,511,513,514,182,516,518,519,521,524,526],{"class":175,"style":176},[173,512,245],{"class":185,"style":186}," result ",[173,515,470],{"class":252,"style":186},[173,517,292],{"class":185,"style":186}," gscdump",[173,520,153],{"class":252,"style":186},[173,522,523],{"class":179,"style":180},"getSiteIndexing",[173,525,242],{"class":203,"style":204},[173,527,205],{"class":203,"style":204},[173,529,530,531,182,533,535,536,182,538,182,541,543],{"class":175,"style":176},"  params",[173,532,431],{"class":252,"style":186},[173,534,205],{"class":203,"style":204}," siteId",[173,537,431],{"class":252,"style":186},[173,539,540],{"class":215,"style":216},"'s_01'",[173,542,209],{"class":203,"style":204},[173,544,253],{"class":252,"style":186},[173,546,547,548,182,550,552,554],{"class":175,"style":176},"  query",[173,549,431],{"class":252,"style":186},[173,551,205],{"class":203,"style":204},[173,553,209],{"class":203,"style":204},[173,555,253],{"class":252,"style":186},[173,557,558,560,562,564,567,569,571,572,574,575,182,577,182,579],{"class":175,"style":176},[173,559,209],{"class":203,"style":204},[173,561,280],{"class":203,"style":204},[173,563,153],{"class":252,"style":186},[173,565,566],{"class":185,"style":186},"catch",[173,568,242],{"class":203,"style":204},[173,570,242],{"class":203,"style":204},"error",[173,573,431],{"class":252,"style":186}," unknown",[173,576,280],{"class":203,"style":204},[173,578,488],{"class":185,"style":186},[173,580,205],{"class":203,"style":204},[173,582,289,583,182,586,588,591,571,593,595,182,597],{"class":175,"style":176},[173,584,585],{"class":185,"style":186},"if",[173,587,242],{"class":203,"style":204},[173,589,590],{"class":179,"style":180},"isGscdumpV1Error",[173,592,242],{"class":203,"style":204},[173,594,280],{"class":203,"style":204},[173,596,280],{"class":203,"style":204},[173,598,205],{"class":203,"style":204},[173,600,601,602,604,606,571,608,142,610,612,613,426,615,612,617,418,619],{"class":175,"style":176},"    console",[173,603,153],{"class":252,"style":186},[173,605,571],{"class":179,"style":180},[173,607,242],{"class":203,"style":204},[173,609,153],{"class":252,"style":186},[173,611,253],{"class":252,"style":186}," error",[173,614,153],{"class":252,"style":186},[173,616,253],{"class":252,"style":186},[173,618,153],{"class":252,"style":186},[173,620,280],{"class":203,"style":204},[173,622,361,623,182,626],{"class":175,"style":176},[173,624,625],{"class":185,"style":186},"return",[173,627,317],{"class":302,"style":303},[173,629,289,630],{"class":175,"style":176},[173,631,209],{"class":203,"style":204},[173,633,289,634,612],{"class":175,"style":176},[173,635,636],{"class":185,"style":186},"throw",[173,638,639,641],{"class":175,"style":176},[173,640,209],{"class":203,"style":204},[173,642,280],{"class":203,"style":204},[138,644,645,646,649],{},"Each OpenAPI operation lists its closed API error set in\n",[142,647,648],{},"x-gscdump-errors",". The SDK also reports local credential, request,\ntransport, and response validation failures with the same tagged error class.",[138,651,652,653,656,657,660,661,664,665,664,668,671,672,153],{},"Successful responses use ",[142,654,655],{},"{ \"data\": ..., \"meta\": ... }",". ",[142,658,659],{},"meta"," includes the\nrequest ID, surface, and wire version. Every HTTP response also carries\n",[142,662,663],{},"x-request-id",", ",[142,666,667],{},"GSCdump-API-Version: 1.0",[142,669,670],{},"Cache-Control: private, no-store",",\nand ",[142,673,674],{},"Vary: Authorization",[158,676,126],{"id":125},[138,678,679],{},"The host applies rate limits per authenticated principal and operation.\nUse the response headers to determine the remaining quota and reset time.",[138,681,682,683,415,686,689,690,693,694,697,698,415,701,153],{},"Quota-evaluated responses include ",[142,684,685],{},"RateLimit-Policy",[142,687,688],{},"RateLimit",". On\n",[142,691,692],{},"429 rate_limited",", wait for the ",[142,695,696],{},"Retry-After"," duration. Treat it as\nauthoritative. If the limiter is unavailable, the host fails closed with a\nretryable ",[142,699,700],{},"503 internal_error",[142,702,703],{},"Retry-After: 5",[138,705,706,707,709],{},"The SDK honors ",[142,708,696],{}," when the operation descriptor allows a retry.",[158,711,129],{"id":128},[138,713,714,715,718],{},"The OpenAPI ",[142,716,717],{},"x-gscdump-semantics"," object records whether an operation is\nidempotent and whether the SDK may retry it. Check each operation before retrying it.",[138,720,721,722,431],{},"Six mutations are non-idempotent and use ",[142,723,724],{},"retry: \"never\"",[726,727,728,734,739,744,749,754],"ul",{},[729,730,731],"li",{},[142,732,733],{},"partner.sites.indexing.inspect.create",[729,735,736],{},[142,737,738],{},"partner.sites.sitemaps.action.create",[729,740,741],{},[142,742,743],{},"partner.sites.registered_host.begin",[729,745,746],{},[142,747,748],{},"partner.teams.create",[729,750,751],{},[142,752,753],{},"partner.users.api_keys.create",[729,755,756],{},[142,757,758],{},"realtime.tickets.create",[138,760,761],{},"The SDK does not automatically retry those five operations. After an ambiguous\nnetwork failure, read authoritative state before deciding whether to issue\nanother mutation. A realtime reconnect always requests a new ticket because\ntickets are single-use.",[138,763,764,765,768,769,772,773,775],{},"For operations marked ",[142,766,767],{},"retry: \"idempotent\"",", the SDK defaults to three total\nattempts and caps configuration at five. It retries network failures and API\nerrors whose envelope says ",[142,770,771],{},"retryable: true",". The backoff starts at 250 ms,\ncaps at two seconds, and waits longer when ",[142,774,696],{}," requires it.",[138,777,778,779,782],{},"V1 currently has no public result-replay contract for ",[142,780,781],{},"Idempotency-Key",". A\nclient-supplied key does not make a non-idempotent operation safe to retry.",{"title":19,"description":113},{"title":19,"description":785,"toc":786},"Import createGscdumpV1Client from @gscdump\u002Fsdk\u002Fv1.\nEach registered operation has a typed convenience method.\nYou can also pass its operation ID to client.execute().",{"title":130,"searchDepth":131,"depth":131,"links":787},[788,789,790,791],{"id":118,"depth":120,"text":119},{"id":122,"depth":120,"text":123},{"id":125,"depth":120,"text":126},{"id":128,"depth":120,"text":129},"sdkDocs\u002Fapi\u002F2.hosted-http.md","md",{"title":19,"description":113},"\u002Fopt\u002Factions-runner\u002F_work\u002Fgscdump.com\u002Fgscdump.com\u002Fnode_modules\u002F.cache\u002Fcomark-content\u002Fgit\u002Fd100867c457f148bef5f\u002Fdocs\u002Fgscdump-sdk\u002Fapi\u002F2.hosted-http.md",{"loc":18},1794983848644]