Skip to main content

Classification services

Classification services allow you to curate new contextual audiences.

Create new segment request​

curl -X "POST" "https://api.clfsy.me/v1/clsfy/segment-requests" \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json' \
     -H 'X-API-Key: 1234' \
     -d $'{
  "block_tlds": [
    "craftsman.com"
  ],
  "example_urls": [
    "https://www.popularmechanics.com/home/tools/a29489351/best-snow-blowers/",
    "https://www.thespruce.com/snow-blowers-and-snow-shovels-4118591"
  ],
  "taxonomy_id": 2,
  "level1_name": "Consumer Goods",
  "level2_name": "Yard maintenance",
  "level3_name": "Snowblowers"
}'

This will create a new request to generate a contextual audience under taxonomy ID 2, under the categories "Consumer Goods" > "Yard Maintenance" > "Snowblowers".

Upon success, you'll see:

{
  "id": 61,
  "client_id": null,
  "taxonomy_id": 2,
  "level1_name": "Consumer Goods",
  "level2_name": "Yard maintenance",
  "level3_name": "Snowblowers",
  "example_urls": [
    "https://www.popularmechanics.com/home/tools/a29489351/best-snow-blowers/",
    "https://www.thespruce.com/snow-blowers-and-snow-shovels-4118591"
  ],
  "extra_hops_count": null,
  "block_tlds": [
    "craftsman.com"
  ],
  "block_keywords": null,
  "deleted": false,
  "created_date": "2025-12-30T22:09:38.463583Z",
  "processed_date": null,
  "processing_errors": null,
  "processing_warnings": null,
  "last_updated_date": null
}

You can poll for updates by checking the processed_date, when it's not null, it means your segment is ready to go.

curl "https://api.clfsy.me/v1/clsfy/segment-requests/61" \
     -H 'Accept: application/json' \
     -H 'X-API-Key: 1234'

Check processed_date.

Delete TLD from segment​

curl -X "DELETE" "https://api.clsfy.me/v1/clsfy/url-classifications/by-tld?tld=totallynotreal.com&result_taxonomy_leaf_id=1234" \
     -H 'Accept: application/json' \
     -H 'X-API-Key: 1234'

Required parameters:

  • tld - the TLD to remove from the audience
  • result_taxonomy_leaf_id - the ID of the audience where URLs should be removed

Response​

Indicates the number of URLs removed from the audience.

{
  "deleted_count": 17
}