PEpeec
Brand Perception

Create Brand Perception Attribute Clusters

Changed on

Add custom attributes to the project's brand-perception market view, the same edit the Add attribute button makes. Each new attribute starts with no terms; a top-of-funnel run is queued for the batch so its market prominence scores populate within a few minutes. A project holds at most 10 custom attributes. Errors: 400 when a name is empty, 409 when the batch would exceed the custom-attribute limit; nothing is added in that case.

post/brand-perception/attribute-clusters/create

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/brand-perception/attribute-clusters/create
  • 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

namesstring[] required

Attributes to add. Each must be unique within the project, case-insensitively; a name that already exists is skipped rather than rejected. A project holds at most 10 custom attributes.

Example request

{
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
  "names": [
    "Sustainability",
    "Customer support"
  ]
}

Response

Success. Every name is either in created or in skipped.

Example response

{
  "created": [
    {
      "cluster_id": "0199a4c1-9f3e-7c21-9f0f-2c0a5d3b1e42",
      "name": "Sustainability"
    }
  ],
  "skipped": [
    {
      "name": "Pricing"
    }
  ]
}

Changes