Get accessibility tree page

client.BrowserRendering.AccessibilityTree.New(ctx, params) (*AccessibilityTreeNewResponse, error)

POST/accounts/{account_id}/browser-rendering/accessibilityTree

Returns the page’s accessibility tree. Use interestingOnly to only return semantically meaningful nodes; use root to scope the tree to a CSS-selector-anchored subtree. Control page loading with gotoOptions and waitFor* options.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Browser Rendering Write

ParametersExpand Collapse

params AccessibilityTreeNewParams

AccountID param.Field[string]

Path param: Account ID.

CacheTTL param.Field[float64]Optional

Query param: Cache TTL default is 5s. Set to 0 to disable.

maximum86400

minimum0

ActionTimeout param.Field[float64]Optional

Body param: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.

maximum120000

AddScriptTag param.Field[[]AccessibilityTreeNewParamsAddScriptTag]Optional

Body param: Adds a <script> tag into the page with the desired URL or content.

ID stringOptional

Content stringOptional

Type stringOptional

URL stringOptional

formaturi

AddStyleTag param.Field[[]AccessibilityTreeNewParamsAddStyleTag]Optional

Body param: Adds a <link rel="stylesheet"> tag into the page with the desired URL or a <style type="text/css"> tag with the content.

Content stringOptional

URL stringOptional

formaturi

AllowRequestPattern param.Field[[]string]Optional

Body param: Only allow requests that match the provided regex patterns, eg. ’/^.*.(css)’.

AllowResourceTypes param.Field[[]AccessibilityTreeNewParamsAllowResourceType]Optional

Body param: Only allow requests that match the provided resource types, eg. ‘image’ or ‘script’.

const AccessibilityTreeNewParamsAllowResourceTypeDocument AccessibilityTreeNewParamsAllowResourceType = "document"

const AccessibilityTreeNewParamsAllowResourceTypeStylesheet AccessibilityTreeNewParamsAllowResourceType = "stylesheet"

const AccessibilityTreeNewParamsAllowResourceTypeImage AccessibilityTreeNewParamsAllowResourceType = "image"

const AccessibilityTreeNewParamsAllowResourceTypeMedia AccessibilityTreeNewParamsAllowResourceType = "media"

const AccessibilityTreeNewParamsAllowResourceTypeFont AccessibilityTreeNewParamsAllowResourceType = "font"

const AccessibilityTreeNewParamsAllowResourceTypeScript AccessibilityTreeNewParamsAllowResourceType = "script"

const AccessibilityTreeNewParamsAllowResourceTypeTexttrack AccessibilityTreeNewParamsAllowResourceType = "texttrack"

const AccessibilityTreeNewParamsAllowResourceTypeXHR AccessibilityTreeNewParamsAllowResourceType = "xhr"

const AccessibilityTreeNewParamsAllowResourceTypeFetch AccessibilityTreeNewParamsAllowResourceType = "fetch"

const AccessibilityTreeNewParamsAllowResourceTypePrefetch AccessibilityTreeNewParamsAllowResourceType = "prefetch"

const AccessibilityTreeNewParamsAllowResourceTypeEventsource AccessibilityTreeNewParamsAllowResourceType = "eventsource"

const AccessibilityTreeNewParamsAllowResourceTypeWebsocket AccessibilityTreeNewParamsAllowResourceType = "websocket"

const AccessibilityTreeNewParamsAllowResourceTypeManifest AccessibilityTreeNewParamsAllowResourceType = "manifest"

const AccessibilityTreeNewParamsAllowResourceTypeSignedexchange AccessibilityTreeNewParamsAllowResourceType = "signedexchange"

const AccessibilityTreeNewParamsAllowResourceTypePing AccessibilityTreeNewParamsAllowResourceType = "ping"

const AccessibilityTreeNewParamsAllowResourceTypeCspviolationreport AccessibilityTreeNewParamsAllowResourceType = "cspviolationreport"

const AccessibilityTreeNewParamsAllowResourceTypePreflight AccessibilityTreeNewParamsAllowResourceType = "preflight"

const AccessibilityTreeNewParamsAllowResourceTypeOther AccessibilityTreeNewParamsAllowResourceType = "other"

Authenticate param.Field[AccessibilityTreeNewParamsAuthenticate]Optional

Body param: Provide credentials for HTTP authentication.

Password string

minLength1

Username string

minLength1

BestAttempt param.Field[bool]Optional

Body param: Attempt to proceed when ‘awaited’ events fail or timeout.

Cookies param.Field[[]AccessibilityTreeNewParamsCookie]Optional

Body param: Check options.

Name string

Cookie name.

Value string

Domain stringOptional

Expires float64Optional

HTTPOnly boolOptional

PartitionKey stringOptional

Path stringOptional

Priority AccessibilityTreeNewParamsCookiesPriorityOptional

One of the following:

const AccessibilityTreeNewParamsCookiesPriorityLow AccessibilityTreeNewParamsCookiesPriority = "Low"

const AccessibilityTreeNewParamsCookiesPriorityMedium AccessibilityTreeNewParamsCookiesPriority = "Medium"

const AccessibilityTreeNewParamsCookiesPriorityHigh AccessibilityTreeNewParamsCookiesPriority = "High"

SameParty boolOptional

SameSite AccessibilityTreeNewParamsCookiesSameSiteOptional

One of the following:

const AccessibilityTreeNewParamsCookiesSameSiteStrict AccessibilityTreeNewParamsCookiesSameSite = "Strict"

const AccessibilityTreeNewParamsCookiesSameSiteLax AccessibilityTreeNewParamsCookiesSameSite = "Lax"

const AccessibilityTreeNewParamsCookiesSameSiteNone AccessibilityTreeNewParamsCookiesSameSite = "None"

Secure boolOptional

SourcePort float64Optional

SourceScheme AccessibilityTreeNewParamsCookiesSourceSchemeOptional

One of the following:

const AccessibilityTreeNewParamsCookiesSourceSchemeUnset AccessibilityTreeNewParamsCookiesSourceScheme = "Unset"

const AccessibilityTreeNewParamsCookiesSourceSchemeNonSecure AccessibilityTreeNewParamsCookiesSourceScheme = "NonSecure"

const AccessibilityTreeNewParamsCookiesSourceSchemeSecure AccessibilityTreeNewParamsCookiesSourceScheme = "Secure"

URL stringOptional

EmulateMediaType param.Field[string]Optional

Body param

GotoOptions param.Field[AccessibilityTreeNewParamsGotoOptions]Optional

Body param: Check options.

Referer stringOptional

ReferrerPolicy stringOptional

Timeout float64Optional

maximum60000

WaitUntil AccessibilityTreeNewParamsGotoOptionsWaitUntilUnionOptional

One of the following:

type AccessibilityTreeNewParamsGotoOptionsWaitUntilString string

One of the following:

const AccessibilityTreeNewParamsGotoOptionsWaitUntilStringLoad AccessibilityTreeNewParamsGotoOptionsWaitUntilString = "load"

const AccessibilityTreeNewParamsGotoOptionsWaitUntilStringDomcontentloaded AccessibilityTreeNewParamsGotoOptionsWaitUntilString = "domcontentloaded"

const AccessibilityTreeNewParamsGotoOptionsWaitUntilStringNetworkidle0 AccessibilityTreeNewParamsGotoOptionsWaitUntilString = "networkidle0"

const AccessibilityTreeNewParamsGotoOptionsWaitUntilStringNetworkidle2 AccessibilityTreeNewParamsGotoOptionsWaitUntilString = "networkidle2"

type AccessibilityTreeNewParamsGotoOptionsWaitUntilArray []AccessibilityTreeNewParamsGotoOptionsWaitUntilArray

One of the following:

const AccessibilityTreeNewParamsGotoOptionsWaitUntilArrayItemLoad AccessibilityTreeNewParamsGotoOptionsWaitUntilArrayItem = "load"

const AccessibilityTreeNewParamsGotoOptionsWaitUntilArrayItemDomcontentloaded AccessibilityTreeNewParamsGotoOptionsWaitUntilArrayItem = "domcontentloaded"

const AccessibilityTreeNewParamsGotoOptionsWaitUntilArrayItemNetworkidle0 AccessibilityTreeNewParamsGotoOptionsWaitUntilArrayItem = "networkidle0"

const AccessibilityTreeNewParamsGotoOptionsWaitUntilArrayItemNetworkidle2 AccessibilityTreeNewParamsGotoOptionsWaitUntilArrayItem = "networkidle2"

HTML param.Field[string]Optional

Body param: Set the content of the page, eg: <h1>Hello World!!</h1>. Either html or url must be set.

minLength1

InterestingOnly param.Field[bool]Optional

Body param

RejectRequestPattern param.Field[[]string]Optional

Body param: Block undesired requests that match the provided regex patterns, eg. ’/^.*.(css)’.

RejectResourceTypes param.Field[[]AccessibilityTreeNewParamsRejectResourceType]Optional

Body param: Block undesired requests that match the provided resource types, eg. ‘image’ or ‘script’.

const AccessibilityTreeNewParamsRejectResourceTypeDocument AccessibilityTreeNewParamsRejectResourceType = "document"

const AccessibilityTreeNewParamsRejectResourceTypeStylesheet AccessibilityTreeNewParamsRejectResourceType = "stylesheet"

const AccessibilityTreeNewParamsRejectResourceTypeImage AccessibilityTreeNewParamsRejectResourceType = "image"

const AccessibilityTreeNewParamsRejectResourceTypeMedia AccessibilityTreeNewParamsRejectResourceType = "media"

const AccessibilityTreeNewParamsRejectResourceTypeFont AccessibilityTreeNewParamsRejectResourceType = "font"

const AccessibilityTreeNewParamsRejectResourceTypeScript AccessibilityTreeNewParamsRejectResourceType = "script"

const AccessibilityTreeNewParamsRejectResourceTypeTexttrack AccessibilityTreeNewParamsRejectResourceType = "texttrack"

const AccessibilityTreeNewParamsRejectResourceTypeXHR AccessibilityTreeNewParamsRejectResourceType = "xhr"

const AccessibilityTreeNewParamsRejectResourceTypeFetch AccessibilityTreeNewParamsRejectResourceType = "fetch"

const AccessibilityTreeNewParamsRejectResourceTypePrefetch AccessibilityTreeNewParamsRejectResourceType = "prefetch"

const AccessibilityTreeNewParamsRejectResourceTypeEventsource AccessibilityTreeNewParamsRejectResourceType = "eventsource"

const AccessibilityTreeNewParamsRejectResourceTypeWebsocket AccessibilityTreeNewParamsRejectResourceType = "websocket"

const AccessibilityTreeNewParamsRejectResourceTypeManifest AccessibilityTreeNewParamsRejectResourceType = "manifest"

const AccessibilityTreeNewParamsRejectResourceTypeSignedexchange AccessibilityTreeNewParamsRejectResourceType = "signedexchange"

const AccessibilityTreeNewParamsRejectResourceTypePing AccessibilityTreeNewParamsRejectResourceType = "ping"

const AccessibilityTreeNewParamsRejectResourceTypeCspviolationreport AccessibilityTreeNewParamsRejectResourceType = "cspviolationreport"

const AccessibilityTreeNewParamsRejectResourceTypePreflight AccessibilityTreeNewParamsRejectResourceType = "preflight"

const AccessibilityTreeNewParamsRejectResourceTypeOther AccessibilityTreeNewParamsRejectResourceType = "other"

Root param.Field[string]Optional

Body param

SetExtraHTTPHeaders param.Field[map[string, string]]Optional

Body param

SetJavaScriptEnabled param.Field[bool]Optional

Body param

URL param.Field[string]Optional

Body param: URL to navigate to, eg. https://example.com.

formaturi

UserAgent param.Field[string]Optional

Body param

Viewport param.Field[AccessibilityTreeNewParamsViewport]Optional

Body param: Check options.

Height float64

Width float64

DeviceScaleFactor float64Optional

HasTouch boolOptional

IsLandscape boolOptional

IsMobile boolOptional

WaitForSelector param.Field[AccessibilityTreeNewParamsWaitForSelector]Optional

Body param: Wait for the selector to appear in page. Check options.

Selector string

Hidden AccessibilityTreeNewParamsWaitForSelectorHiddenOptional

Timeout float64Optional

maximum120000

Visible AccessibilityTreeNewParamsWaitForSelectorVisibleOptional

WaitForTimeout param.Field[float64]Optional

Body param: Waits for a specified timeout before continuing.

maximum120000

ReturnsExpand Collapse

type AccessibilityTreeNewResponse struct{…}

AccessibilityTree AccessibilityTreeNewResponseAccessibilityTree

Accessibility tree node

Role string

Autocomplete stringOptional

Checked AccessibilityTreeNewResponseAccessibilityTreeCheckedUnionOptional

One of the following:

UnionBool

type AccessibilityTreeNewResponseAccessibilityTreeCheckedString string

Children []unknownOptional

Description stringOptional

Disabled boolOptional

Expanded boolOptional

Focused boolOptional

Haspopup stringOptional

Invalid stringOptional

Keyshortcuts stringOptional

Level float64Optional

Multiline boolOptional

Multiselectable boolOptional

Name stringOptional

Orientation stringOptional

Pressed AccessibilityTreeNewResponseAccessibilityTreePressedUnionOptional

One of the following:

UnionBool

type AccessibilityTreeNewResponseAccessibilityTreePressedString string

Readonly boolOptional

Required boolOptional

Roledescription stringOptional

Selected boolOptional

Value AccessibilityTreeNewResponseAccessibilityTreeValueUnionOptional

One of the following:

UnionString

UnionFloat

Valuemax float64Optional

Valuemin float64Optional

Valuetext stringOptional

Get accessibility tree page

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/browser_rendering"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  accessibilityTree, err := client.BrowserRendering.AccessibilityTree.New(context.TODO(), browser_rendering.AccessibilityTreeNewParams{
    AccountID: cloudflare.F("account_id"),
    URL: cloudflare.F("https://www.example.com/"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", accessibilityTree.AccessibilityTree)
}

{
  "meta": {
    "headers": {
      "foo": "string"
    },
    "status": 0,
    "title": "title"
  },
  "result": {
    "accessibilityTree": {
      "role": "role",
      "autocomplete": "autocomplete",
      "checked": "mixed",
      "children": [
        {}
      ],
      "description": "description",
      "disabled": true,
      "expanded": true,
      "focused": true,
      "haspopup": "haspopup",
      "invalid": "invalid",
      "keyshortcuts": "keyshortcuts",
      "level": 0,
      "modal": true,
      "multiline": true,
      "multiselectable": true,
      "name": "name",
      "orientation": "orientation",
      "pressed": "mixed",
      "readonly": true,
      "required": true,
      "roledescription": "roledescription",
      "selected": true,
      "value": "string",
      "valuemax": 0,
      "valuemin": 0,
      "valuetext": "valuetext"
    }
  },
  "success": true,
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ]
}

{
  "errors": [
    {
      "code": 2001,
      "message": "Rate limit exceeded"
    }
  ],
  "success": false
}

Returns Examples

{
  "meta": {
    "headers": {
      "foo": "string"
    },
    "status": 0,
    "title": "title"
  },
  "result": {
    "accessibilityTree": {
      "role": "role",
      "autocomplete": "autocomplete",
      "checked": "mixed",
      "children": [
        {}
      ],
      "description": "description",
      "disabled": true,
      "expanded": true,
      "focused": true,
      "haspopup": "haspopup",
      "invalid": "invalid",
      "keyshortcuts": "keyshortcuts",
      "level": 0,
      "modal": true,
      "multiline": true,
      "multiselectable": true,
      "name": "name",
      "orientation": "orientation",
      "pressed": "mixed",
      "readonly": true,
      "required": true,
      "roledescription": "roledescription",
      "selected": true,
      "value": "string",
      "valuemax": 0,
      "valuemin": 0,
      "valuetext": "valuetext"
    }
  },
  "success": true,
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ]
}

{
  "errors": [
    {
      "code": 2001,
      "message": "Rate limit exceeded"
    }
  ],
  "success": false
}