Project

Set URL Classification

Assign a built-in or custom classification to a URL (overriding any heuristic classification), or clear the assignment by passing null.

put/classifications/url-assignments

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/classifications/url-assignments
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Request body

project_idstring

Required if using a company api key

urlstring required

URL to classify. The override applies to the normalized form, so it covers every source row that canonicalizes to the same URL.

classificationstring nullable required

Built-in classification (HOMEPAGE, CATEGORY_PAGE, PRODUCT_PAGE, LISTICLE, COMPARISON, PROFILE, ALTERNATIVE, DISCUSSION, HOW_TO_GUIDE, ARTICLE, REVIEW, OTHER) or the name of a custom URL classification. Pass null to clear the assignment.

Example request

{
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}

Response

URL classification assignment updated

object required

URL classification assignment updated

Changes

No recorded changes to this operation across all 3 revisions of this API.