POST
/
html_filters
curl --request POST \
  --url https://api.beyondwords.io/v1/html_filters \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "element_type": "div",
  "element_id": "test",
  "project": {
    "id": 1
  }
}'
{
  "id": 1,
  "element_type": "div",
  "element_id": "test",
  "include": true
}

Authorizations

​
X-Api-Key
string
header
required

Body

application/json
​
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 | null

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

​
project
object | null

The project id to apply this filter to

Response

201 - application/json
successful
​
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
Get filter
Next