Answer analysis — brand mentions, rank, sentiment and source types

​

Request

curl -X POST https://api.querying.ai/v1/async/task \
  -H "Authorization: Bearer $QUERYING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "taskType": "CHATGPT",
    "payload": {
      "prompt": "best CRM for a small team",
      "country": "US",
      "include": { "analysis": true },
      "brand": "Acme CRM",
      "brandAliases": ["Acme"],
      "brandDomains": ["acme-crm.example"],
      "competitors": ["Northwind", { "name": "Contoso CRM", "aliases": ["Contoso"], "domains": ["contoso-crm.example"] }]
    }
  }'

​

Supported engines

​

Credits

​

Response

{
  "analysis": {
    "version": 1,
    "status": "ok",
    "brands": [
      { "name": "Northwind", "domain": null, "writtenAs": "Northwind", "spellings": ["Northwind"], "rank": 1, "role": "competitor", "recommended": true, "sentiment": "positive", "sentimentScore": 0.9 },
      { "name": "Acme CRM", "domain": "acme-crm.example", "writtenAs": "Acme", "spellings": ["Acme", "Acme CRM"], "rank": 2, "role": "brand", "recommended": true, "sentiment": "positive", "sentimentScore": 0.5 },
      { "name": "Fabrikam", "domain": "fabrikam.example", "writtenAs": "Fabrikam", "spellings": ["Fabrikam"], "rank": 3, "role": null, "recommended": false, "sentiment": "neutral", "sentimentScore": 0 }
    ],
    "targets": [
      { "name": "Acme CRM", "role": "brand", "mentioned": true, "rank": 2, "recommended": true, "sentiment": "positive", "sentimentScore": 0.5, "cited": true },
      { "name": "Northwind", "role": "competitor", "mentioned": true, "rank": 1, "recommended": true, "sentiment": "positive", "sentimentScore": 0.9, "cited": false },
      { "name": "Contoso CRM", "role": "competitor", "mentioned": false, "rank": null, "recommended": null, "sentiment": null, "sentimentScore": null, "cited": false }
    ],
    "sources": [
      { "position": 1, "url": "https://www.acme-crm.example/pricing", "domain": "acme-crm.example", "kind": "owned", "brand": "Acme CRM" },
      { "position": 2, "url": "https://www.g2.com/categories/crm", "domain": "g2.com", "kind": "reviews", "brand": null }
    ]
  }
}

​

How it decides

• Which names are brands, which of them is yours, recommended and sentiment are judged by a model. Positions, ranks, name matching and source kinds are computed by rules, so the same model reading gives the same result.
• Your brand and competitors are found by their names and aliases with the same rules a monitor uses: whole words in Latin script, anywhere in Korean, Japanese, Chinese and Thai, never inside a citation link. The model also connects other spellings it finds. A spelling or product name counts for your brand or a competitor only when it is that brand’s own name, short name, name in another language, maker, or product; a generic word, another brand, or another brand’s product never counts. A name you send with a capital, such as Across, that the answer writes only in lowercase counts only when the model reads it as the brand: “works across teams” does not count, “adidas Runfalcon” does. A spelling it confirms as the brand’s own name, such as 컬리 for Kurly, is kept and matched by rule in later answers. A name the answer does not contain is never reported.
• When your name matches but the model did not read it as a brand in this answer (a common word used another way), the brand is listed with recommended, sentiment and sentimentScore set to null.
• A model names each brand you did not send the first time any answer writes it, and its name and site are reused for every later answer. Brands already named with a cited site or a similar spelling are offered to it, so a branch or another script resolves to the same name. When naming fails, the brand keeps the answer’s spelling and domain is null.
• One site is one brand: brands named with the same site are reported once, under the site’s own name (Baemin for baemin.com) or else the name it was first given, so 아임웹 and I’mweb are one brand, and a brand found on the site of one you sent is that brand. A post on a blog, community, video or social platform is not linked to a brand you did not send, even on that brand’s own platform, such as blog.naver.com for NAVER.
• A name the model reads as no brand, such as a generic word, a place or a treatment, is left out. Brands an answer writes as one name, such as “마켓컬리, 오아시스마켓, SSG닷컴”, count as each brand, and a description after a name is not part of it.
• The model reads the first 40,000 characters of the answer. A brand first named after that is not reported.
• The analysis adds a few seconds before the task completes.

​

Statuses

​

Errors

​

Related

• Markdown and raw responses
• GEO monitoring: run the same analysis on a schedule.
• Engine overview