Brand Perception

List Brand Perception Attribute Clusters

Changed on

The project's brand-perception attribute taxonomy: every attribute with its id, name and terms (the raw phrasings from AI answers grouped under it), plus the unassigned terms no attribute claims. Unlike the brand-attributes endpoint this is the editable grouping rather than the scored snapshot, so it also lists attributes that carry no score yet. Use it to resolve the cluster_id values the edit endpoint takes and the create endpoint returns.

get/brand-perception/attribute-clusters

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/brand-perception/attribute-clusters
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Query parameters

project_idstring

Required if using a company api key

Example:or_f45b94ba-5e35-4982-93ed-285e72ee14eb
limitinteger
offsetinteger

Response

Success

total_countnumber required

Total number of attributes, ignoring pagination

unassignedstring[] required

Terms that belong to no attribute yet. Move one into an attribute to give it a home. Not paginated.

Example response

{
  "data": [
    {
      "cluster_id": "0199a4c1-9f3e-7c21-9f0f-2c0a5d3b1e42",
      "name": "Luxury",
      "members": [
        "luxury",
        "prestige",
        "exclusivity"
      ]
    }
  ],
  "total_count": 12,
  "unassigned": [
    "hand-built"
  ]
}

Changes