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.

HTML param.Field[string]

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

minLength1

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[[]AccessibilityTreeNewParamsVariant0AddScriptTag]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[[]AccessibilityTreeNewParamsVariant0AddStyleTag]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[[]AccessibilityTreeNewParamsVariant0AllowResourceType]Optional

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

const AccessibilityTreeNewParamsVariant0AllowResourceTypeDocument AccessibilityTreeNewParamsVariant0AllowResourceType = "document"

const AccessibilityTreeNewParamsVariant0AllowResourceTypeStylesheet AccessibilityTreeNewParamsVariant0AllowResourceType = "stylesheet"

const AccessibilityTreeNewParamsVariant0AllowResourceTypeImage AccessibilityTreeNewParamsVariant0AllowResourceType = "image"

const AccessibilityTreeNewParamsVariant0AllowResourceTypeMedia AccessibilityTreeNewParamsVariant0AllowResourceType = "media"

const AccessibilityTreeNewParamsVariant0AllowResourceTypeFont AccessibilityTreeNewParamsVariant0AllowResourceType = "font"

const AccessibilityTreeNewParamsVariant0AllowResourceTypeScript AccessibilityTreeNewParamsVariant0AllowResourceType = "script"

const AccessibilityTreeNewParamsVariant0AllowResourceTypeTexttrack AccessibilityTreeNewParamsVariant0AllowResourceType = "texttrack"

const AccessibilityTreeNewParamsVariant0AllowResourceTypeXHR AccessibilityTreeNewParamsVariant0AllowResourceType = "xhr"

const AccessibilityTreeNewParamsVariant0AllowResourceTypeFetch AccessibilityTreeNewParamsVariant0AllowResourceType = "fetch"

const AccessibilityTreeNewParamsVariant0AllowResourceTypePrefetch AccessibilityTreeNewParamsVariant0AllowResourceType = "prefetch"

const AccessibilityTreeNewParamsVariant0AllowResourceTypeEventsource AccessibilityTreeNewParamsVariant0AllowResourceType = "eventsource"

const AccessibilityTreeNewParamsVariant0AllowResourceTypeWebsocket AccessibilityTreeNewParamsVariant0AllowResourceType = "websocket"

const AccessibilityTreeNewParamsVariant0AllowResourceTypeManifest AccessibilityTreeNewParamsVariant0AllowResourceType = "manifest"

const AccessibilityTreeNewParamsVariant0AllowResourceTypeSignedexchange AccessibilityTreeNewParamsVariant0AllowResourceType = "signedexchange"

const AccessibilityTreeNewParamsVariant0AllowResourceTypePing AccessibilityTreeNewParamsVariant0AllowResourceType = "ping"

const AccessibilityTreeNewParamsVariant0AllowResourceTypeCspviolationreport AccessibilityTreeNewParamsVariant0AllowResourceType = "cspviolationreport"

const AccessibilityTreeNewParamsVariant0AllowResourceTypePreflight AccessibilityTreeNewParamsVariant0AllowResourceType = "preflight"

const AccessibilityTreeNewParamsVariant0AllowResourceTypeOther AccessibilityTreeNewParamsVariant0AllowResourceType = "other"

Authenticate param.Field[AccessibilityTreeNewParamsVariant0Authenticate]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[[]AccessibilityTreeNewParamsVariant0Cookie]Optional

Body param: Check options.

Name string

Cookie name.

Value string

Domain stringOptional

Expires float64Optional

HTTPOnly boolOptional

PartitionKey stringOptional

Path stringOptional

Priority AccessibilityTreeNewParamsVariant0CookiesPriorityOptional

One of the following:

const AccessibilityTreeNewParamsVariant0CookiesPriorityLow AccessibilityTreeNewParamsVariant0CookiesPriority = "Low"

const AccessibilityTreeNewParamsVariant0CookiesPriorityMedium AccessibilityTreeNewParamsVariant0CookiesPriority = "Medium"

const AccessibilityTreeNewParamsVariant0CookiesPriorityHigh AccessibilityTreeNewParamsVariant0CookiesPriority = "High"

SameParty boolOptional

SameSite AccessibilityTreeNewParamsVariant0CookiesSameSiteOptional

One of the following:

const AccessibilityTreeNewParamsVariant0CookiesSameSiteStrict AccessibilityTreeNewParamsVariant0CookiesSameSite = "Strict"

const AccessibilityTreeNewParamsVariant0CookiesSameSiteLax AccessibilityTreeNewParamsVariant0CookiesSameSite = "Lax"

const AccessibilityTreeNewParamsVariant0CookiesSameSiteNone AccessibilityTreeNewParamsVariant0CookiesSameSite = "None"

Secure boolOptional

SourcePort float64Optional

SourceScheme AccessibilityTreeNewParamsVariant0CookiesSourceSchemeOptional

One of the following:

const AccessibilityTreeNewParamsVariant0CookiesSourceSchemeUnset AccessibilityTreeNewParamsVariant0CookiesSourceScheme = "Unset"

const AccessibilityTreeNewParamsVariant0CookiesSourceSchemeNonSecure AccessibilityTreeNewParamsVariant0CookiesSourceScheme = "NonSecure"

const AccessibilityTreeNewParamsVariant0CookiesSourceSchemeSecure AccessibilityTreeNewParamsVariant0CookiesSourceScheme = "Secure"

URL stringOptional

EmulateMediaType param.Field[string]Optional

Body param

GotoOptions param.Field[AccessibilityTreeNewParamsVariant0GotoOptions]Optional

Body param: Check options.

Referer stringOptional

ReferrerPolicy stringOptional

Timeout float64Optional

maximum60000

WaitUntil AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilUnionOptional

One of the following:

AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilString

One of the following:

const AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilStringLoad AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilString = "load"

const AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilStringDomcontentloaded AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilString = "domcontentloaded"

const AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle0 AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilString = "networkidle0"

const AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle2 AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilString = "networkidle2"

AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilArray

One of the following:

const AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilArrayLoad AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilArray = "load"

const AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilArrayDomcontentloaded AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilArray = "domcontentloaded"

const AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle0 AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilArray = "networkidle0"

const AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle2 AccessibilityTreeNewParamsVariant0GotoOptionsWaitUntilArray = "networkidle2"

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[[]AccessibilityTreeNewParamsVariant0RejectResourceType]Optional

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

const AccessibilityTreeNewParamsVariant0RejectResourceTypeDocument AccessibilityTreeNewParamsVariant0RejectResourceType = "document"

const AccessibilityTreeNewParamsVariant0RejectResourceTypeStylesheet AccessibilityTreeNewParamsVariant0RejectResourceType = "stylesheet"

const AccessibilityTreeNewParamsVariant0RejectResourceTypeImage AccessibilityTreeNewParamsVariant0RejectResourceType = "image"

const AccessibilityTreeNewParamsVariant0RejectResourceTypeMedia AccessibilityTreeNewParamsVariant0RejectResourceType = "media"

const AccessibilityTreeNewParamsVariant0RejectResourceTypeFont AccessibilityTreeNewParamsVariant0RejectResourceType = "font"

const AccessibilityTreeNewParamsVariant0RejectResourceTypeScript AccessibilityTreeNewParamsVariant0RejectResourceType = "script"

const AccessibilityTreeNewParamsVariant0RejectResourceTypeTexttrack AccessibilityTreeNewParamsVariant0RejectResourceType = "texttrack"

const AccessibilityTreeNewParamsVariant0RejectResourceTypeXHR AccessibilityTreeNewParamsVariant0RejectResourceType = "xhr"

const AccessibilityTreeNewParamsVariant0RejectResourceTypeFetch AccessibilityTreeNewParamsVariant0RejectResourceType = "fetch"

const AccessibilityTreeNewParamsVariant0RejectResourceTypePrefetch AccessibilityTreeNewParamsVariant0RejectResourceType = "prefetch"

const AccessibilityTreeNewParamsVariant0RejectResourceTypeEventsource AccessibilityTreeNewParamsVariant0RejectResourceType = "eventsource"

const AccessibilityTreeNewParamsVariant0RejectResourceTypeWebsocket AccessibilityTreeNewParamsVariant0RejectResourceType = "websocket"

const AccessibilityTreeNewParamsVariant0RejectResourceTypeManifest AccessibilityTreeNewParamsVariant0RejectResourceType = "manifest"

const AccessibilityTreeNewParamsVariant0RejectResourceTypeSignedexchange AccessibilityTreeNewParamsVariant0RejectResourceType = "signedexchange"

const AccessibilityTreeNewParamsVariant0RejectResourceTypePing AccessibilityTreeNewParamsVariant0RejectResourceType = "ping"

const AccessibilityTreeNewParamsVariant0RejectResourceTypeCspviolationreport AccessibilityTreeNewParamsVariant0RejectResourceType = "cspviolationreport"

const AccessibilityTreeNewParamsVariant0RejectResourceTypePreflight AccessibilityTreeNewParamsVariant0RejectResourceType = "preflight"

const AccessibilityTreeNewParamsVariant0RejectResourceTypeOther AccessibilityTreeNewParamsVariant0RejectResourceType = "other"

Root param.Field[string]Optional

Body param

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

Body param

SetJavaScriptEnabled param.Field[bool]Optional

Body param

UserAgent param.Field[string]Optional

Body param

Viewport param.Field[AccessibilityTreeNewParamsVariant0Viewport]Optional

Body param: Check options.

Height float64

Width float64

DeviceScaleFactor float64Optional

HasTouch boolOptional

IsLandscape boolOptional

IsMobile boolOptional

WaitForSelector param.Field[AccessibilityTreeNewParamsVariant0WaitForSelector]Optional

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

Selector string

Hidden AccessibilityTreeNewParamsVariant0WaitForSelectorHiddenOptional

Timeout float64Optional

maximum120000

Visible AccessibilityTreeNewParamsVariant0WaitForSelectorVisibleOptional

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"),
    Body: browser_rendering.AccessibilityTreeNewParamsBodyObject{
      URL: cloudflare.F("https://www.example.com/"),
    },
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", accessibilityTree.AccessibilityTree)
}

{
  "meta": {
    "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": {
    "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
}