GET
/
html_filters
curl --request GET \
  --url https://api.beyondwords.io/v1/html_filters \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": 1,
    "element_type": "div",
    "include": true
  },
  {
    "id": 2,
    "element_type": "p",
    "include": true
  }
]

Authorizations

​
X-Api-Key
string
header
required

Query Parameters

​
pagination[limit]
integer

'limit' sets the number of results to return in each page.

​
pagination[offset]
integer

'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.

​
filter[project.id]
string

filter by project ID

​
filter[scopes]
object

filter items by scopes

​
filter[selector]
string

filter by element attributes

​
filter[include]
boolean
​
filter[types][]
enum<string>[]

filter by filter types

Available options:
element_class,
element_data,
element_type,
element_xpath,
element_id,
value

Response

200
application/json
OK
​
id
integer
​
element_type
string | null

The name of the tag representing the element

​
element_class
string | null

The class attribute of an element. This filter will be applied to any element that contains the class

​
element_data
string | null

The data attribute of an element

​
element_xpath
string | null

The XPath specifying the elements. https://www.w3.org/TR/1999/REC-xpath-19991116/

​
element_id
string | null

The class attribute of an element

​
value
string | null

The string value contained within an element. This filter will be applied to any element that contains the value

​
include
boolean

Whether BeyondWords should use the filter to include or exclude the selected part of the HTML document. The default is false

​
created
string

Time at which the object was created (ISO 8601)

​
updated
string

Time at which the object was updated (ISO 8601)

​
project
object | null

The project id to apply this filter to

Previous
Create filter
Next