Felo API PlatformFelo API Platform

데이터 API / DataForSEO / On Page

OnPage API Page Screenshot

Renders any url and returns a screenshot, with full_page_screenshot for the whole scroll height and browser_screen_width and browser_screen_height setting the viewport. Standalone - no crawl needed. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. ⚠️ An image is a large tool result even before an agent can do anything with it; ask for a screenshot only when the visual is the point, and use post_dataforseo_on_page_content_parsing_live when the text is.

파라미터

경로, 쿼리, 헤더 파라미터가 없습니다.

요청 본문

  • urlstring필수

    page url required field absolute URL of the page to snap note: if the URL you indicate here returns a 404 status code or the indicated value is not a valid URL, you will obtain "error_message":"Screenshot is empty" in the response array

  • accept_languagestring선택

    language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) note: if you do not specify this parameter, some websites may deny access; in this case, you will obtain "error_message":"Screenshot is empty" in the response array

  • custom_user_agentstring선택

    custom user agent optional field custom user agent for crawling a website example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36 default value: Mozilla/5.0 (compatible; RSiteAuditor)

  • browser_presetstring선택

    preset for browser screen parameters optional field if you use this field, you don’t need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factor possible values: desktop, mobile, tablet desktop preset will apply the following values: browser_screen_width: 1920 browser_screen_height: 1080 browser_screen_scale_factor: 1 mobile preset will apply the following values: browser_screen_width: 390 browser_screen_height: 844 browser_screen_scale_factor: 3 tablet preset will apply the following values: browser_screen_width: 1024 browser_screen_height: 1366 browser_screen_scale_factor: 2 Note: in this endpoint, the enable_browser_rendering, enable_javascript, load_resources, and enable_xhr parameters are always enabled.

  • browser_screen_widthinteger선택

    browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; minimum value, in pixels: 240 maximum value, in pixels: 9999

  • browser_screen_heightinteger선택

    browser screen height optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; minimum value, in pixels: 240 maximum value, in pixels: 9999

  • browser_screen_scale_factornumber선택

    browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; minimum value: 0.5 maximum value: 3

  • full_page_screenshotboolean선택

    take a screenshot of the full page optional field set to false if you want to capture only the part of the page displayed before scrolling default value: true

  • disable_cookie_popupboolean선택

    disable the cookie popup optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false

  • switch_poolboolean선택

    switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors

  • ip_pool_for_scanstring선택

    proxy pool optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors possible values: us, de

요청 예시

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/on_page/page_screenshot" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "<string>",
  "accept_language": "<string>",
  "custom_user_agent": "<string>",
  "browser_preset": "<string>",
  "browser_screen_width": 0,
  "browser_screen_height": 0,
  "browser_screen_scale_factor": 0,
  "full_page_screenshot": false
}'

응답

응답 필드

  • versionstring선택

    the current version of the API

  • status_codeinteger선택

    general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions

  • status_messagestring선택

    general informational message you can find the full list of general informational messages here

  • timestring선택

    execution time, seconds

  • costnumber선택

    total tasks cost, USD

  • tasks_countinteger선택

    the number of tasks in the tasks array

  • tasks_errorinteger선택

    the number of tasks in the tasks array returned with an error

  • tasksstring[]선택

    array of tasks

  • idstring선택

    task identifier unique task identifier in our system in the UUID format

  • status_codeinteger선택

    status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here

  • status_messagestring선택

    informational message of the task you can find the full list of general informational messages here

  • timestring선택

    execution time, seconds

  • costnumber선택

    cost of the task, USD

  • result_countinteger선택

    number of elements in the result array

  • pathstring[]선택

    URL path

  • dataobject선택

    contains the same parameters that you specified in the POST request

  • resultstring[]선택

    array of results

  • crawl_progressstring선택

    status of the crawling session possible values: in_progress, finished

  • error_messagestring선택

    error message if the url you indicated returns a 404 status code or is not a valid URL, you will obtain "error_message":"Screenshot is empty" if no error is encountered, the value will be null

  • items_countinteger선택

    number of items in the results array

  • itemsstring[]선택

    items array

  • imagestring선택

    screenshot of the requested page URL of the page screenshot on the DataForSEO storage