List org custom attributes for a domain

GET

/api/v1/extraction/attributes/{domain}

const url = 'https://dashboard.justcrawl.io/api/v1/extraction/attributes/example?pageType=product';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://dashboard.justcrawl.io/api/v1/extraction/attributes/example?pageType=product' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

domain

required

string

Query Parameters

pageType

string

default: product

Responses

200

Org-defined custom attributes for the domain + page type

application/json

Org-scoped custom attributes. When no row exists, the API returns { attributes: [] } and other fields are omitted.

object

string format: uuid

orgId

string format: uuid

domain

string

pageType

string

attributes

required

Array<object>

object

name

required

string

xpaths

required

Array<string>

type

required

string

Allowed values: text number url boolean text[] url[]

description

string

nullable

antiPatterns

Array<string>

nullable

semanticType

string

nullable

Allowed values: brand_name review_count product_id product_image star_rating

validation

object

minLength

integer

maxLength

integer

min

number

max

number

pattern

string

createdAt

string format: date-time

updatedAt

string format: date-time

Example

{
  "attributes": [
    {
      "type": "text",
      "semanticType": "brand_name"
    }
  ]
}