PEpeec
Brand Perception

Get Brand Perception Attribute Rankings

Changed on

How the project's own brand ranks against competitors for each brand-perception attribute. The ranking is the own brand's mean position across AI answers mentioning the attribute (lower is better). The data is aggregated across the brand-perception runs of one industry and one target market — there is no date range. Pass industry to pick the industry; omitted, it is the one with the most recent completed run. The target market is always the industry's most recently completed one and cannot be picked. Both are returned as industry and target_market.

get/brand-perception/attribute-rankings

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/brand-perception/attribute-rankings
  • 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
model_channel_idsstring[]

Only include answers from these AI engine channels (repeat the parameter for multiple values). Omit to aggregate across all tracked channels.

industrystring

Only read the runs dispatched for this industry, as returned by the brand-perception industries endpoint. Omit to read the industry marked is_default there — the one with the most recent completed run.

Example:Luxury Sports Cars
searchstring

Case-insensitive substring filter on the attribute name.

Example:heritage
limitinteger
offsetinteger

Response

Success

total_countnumber required

Total number of matching attributes, ignoring pagination

industrystring nullable required

The industry the data was read from; null when the project has no brand-perception runs yet.

target_marketstring nullable required

The target market the read narrowed to within that industry — its most recently completed one. Runs dispatched for the industry's other markets are not included.

Example response

{
  "data": [
    {
      "name": "Italian Heritage",
      "ranking": 2,
      "competitors": [
        {
          "name": "Porsche",
          "domain": "porsche.com"
        }
      ]
    }
  ],
  "total_count": 8,
  "industry": "Luxury Sports Cars",
  "target_market": "Germany",
  "industries": [
    {
      "name": "Athleisure"
    }
  ]
}

Changes