Analyze

Automatically classify a page and extract data according to its type.

byDiffbot Extract API (Web Extraction)

924calls

1990mslatency

Insufficient datasuccess rate

Discover -> Inspect -> Call

Call setup

Tool IDdiffbot.analyze.retrieve.v1.774d6095

Request parametersJSON

Before this Call

1 credit / call

The final charge is settled from actual provider usage and will appear in Usage.

Field reference

urlstringRequired

Web page URL of the analyze to process (URL encoded)

modestringOptional

By default the Analyze API will fully extract all pages that match an existing Extract API. Set mode to a specific Extract API (e.g., `mode="article"`) to extract content only from that specific page-type. All other pages will simply return the default Analyze fields.

fallbackstringOptional

If an appropriate API cannot be determined (pages classified with type "other"), fall back to this API.

fieldsstringOptional

Specify optional fields to be returned from any fully-extracted pages (e.g. `fields=querystring,links`)

discussionbooleanOptional

Pass `discussion=false` to disable automatic extraction of comments or reviews from pages identified as articles or products. This will not affect pages identified as discussions.

timeoutintegerOptional

Sets a value in milliseconds to wait for the retrieval/fetch of content from the requested URL. The default timeout for the third-party response is 30 seconds (30000).

callbackstringOptional

Use for jsonp requests. Needed for cross-domain ajax.

proxystringOptional

Specify an IP address of a [custom proxy](https://docs.diffbot.com/reference/using-proxies#how-to-use-proxies) that will be used to fetch the target page. (Ex: `&proxy` or `&proxy=0.0.0.0`)

proxyAuthstringOptional

Used to specify the authentication parameters that will be used with a custom proxy specified in the &proxy parameter. (Ex: `proxyAuth=username:password`)

useProxystringOptional

Set to `default` to use [Diffbot's datacenter proxy](https://docs.diffbot.com/reference/using-proxies#how-to-use-proxies) for this request. `none` will instruct Extract to not use proxies, even if proxies have been enabled for this particular URL globally.