changedOutput schema / properties / error / description
Previous value: -"Error message if the job ended in `failed`"New value: +"Error message if the job ended in `failed`. A job whose page the site served, even a 404 page, ends `done`, not `failed`: read `page_status_code` in the `scrape_result`."
changedOutput schema / properties / response_meta / description
Previous value: -"Usage accounting for the finished job. Present only once the job is `done`; `response_meta.usage` reports credits charged, the billed engine, the resolved proxy tier, and any screenshot-slice add-on."New value: +"Usage accounting for the finished job. Present only once the job is `done`; `response_meta.usage` reports what the job cost (total_credit_cost and its parts), the billed engine and the resolved proxy tier."
changedOutput schema / properties / response_meta / properties / usage / description
Previous value: -"Usage accounting for this request: credits charged, billed engine, resolved proxy tier, and screenshot-slice add-on."New value: +"What this request cost and why: total_credit_cost = engine_credit_cost × proxy_multiplier + screenshot_slicing_credit_cost, plus the billed engine and the resolved proxy tier."
addedOutput schema / properties / response_meta / properties / usage / properties / credits / deprecated
Added value: +true
changedOutput schema / properties / response_meta / properties / usage / properties / credits / description
Previous value: -"Credits actually charged for this request. Always equals the engine base × the proxy multiplier, plus screenshot_slices. A cache hit has engine \"cache\" (base 0), so it costs only the parts we still had to compute — a newly produced screenshot-slice variant — and is otherwise free."New value: +"Deprecated: use total_credit_cost, which always has the same value. This field will be removed in a future version."
changedOutput schema / properties / response_meta / properties / usage / properties / engine / description
Previous value: -"The engine base the request was billed at — \"http\" (1 credit), \"browser\" (3), \"screenshot\" (5), or \"cache\" (0, the result was served from cache) — before the proxy multiplier. Reflects what was delivered, never what was requested."New value: +"The engine the request was billed at — \"http\", \"browser\", \"screenshot\", or \"cache\" (the result was served from cache). Reflects what was delivered, never what was requested."
addedOutput schema / properties / response_meta / properties / usage / properties / engine_credit_cost
Added value: +{
+ "description": "The engine base charged, before the proxy multiplier: 1 for \"http\", 3 for \"browser\", 5 for \"screenshot\", 0 for \"cache\". Also 0 when the page is not billed (see page_status_code). Older api versions do not send it.",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+}
changedOutput schema / properties / response_meta / properties / usage / properties / proxy / description
Previous value: -"The proxy tier the request actually ran on (resolved value — never `auto`; `auto` is resolved server-side to `basic` or `advanced`)."New value: +"The proxy tier the request actually ran on (resolved value — never `auto`; `auto` is resolved server-side to `basic` or `advanced`). \"advanced\" multiplies the engine base by 5."
addedOutput schema / properties / response_meta / properties / usage / properties / proxy_multiplier
Added value: +{
+ "description": "The multiplier of the proxy tier the request ran on: 1 for \"basic\", 5 for \"advanced\". Always reported, even when the engine cost is 0. Older api versions do not send it.",
+ "exclusiveMinimum": 0,
+ "maximum": 9007199254740991,
+ "type": "integer"
+}
addedOutput schema / properties / response_meta / properties / usage / properties / screenshot_slices / deprecated
Added value: +true
changedOutput schema / properties / response_meta / properties / usage / properties / screenshot_slices / description
Previous value: -"Whether this request was billed the screenshot-split add-on: 1 when the screenshot was split on this request (a flat +1 credit outside the proxy multiplier, regardless of how many slices the split produced), else 0 — including a cache hit that reused an already-existing slice variant."New value: +"Deprecated: use screenshot_slicing_credit_cost, which always has the same value. Despite its name this is a 0/1 charge, not a count of slices. This field will be removed in a future version."
addedOutput schema / properties / response_meta / properties / usage / properties / screenshot_slicing_credit_cost
Added value: +{
+ "description": "The screenshot slicing add-on: 1 when the screenshot was split into slices on this request (a flat +1 credit outside the proxy multiplier, however many slices it made), else 0. A cache hit that reused slices that already existed costs 0. Older api versions do not send it; read `screenshot_slices` then, which has the same value.",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+}
addedOutput schema / properties / response_meta / properties / usage / properties / total_credit_cost
Added value: +{
+ "description": "Credits charged for this request. Always equals engine_credit_cost × proxy_multiplier + screenshot_slicing_credit_cost. 0 when nothing is billed: a cache hit, or a page whose status is not billed (see page_status_code). Older api versions do not send it; read `credits` then, which has the same value.",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+}
changedOutput schema / properties / response_meta / properties / usage / required
Previous value: -[
- "credits",
- "engine",
- "proxy",
- "screenshot_slices"
-]New value: +[
+ "engine",
+ "proxy"
+]