Skip to content
/
Score Companies

Score Companies

Request

Scores up to 25 companies against up to 6 of your organization's live AI scoring models.

Identify companies by ids or domains, exactly as companies/enrich does. Returns one row per company per model; a company that is not scored by a model comes back with null scores rather than failing the request.

Each row carries fit_score_details, need_score_details and intent_score_details, the dimension-by-dimension breakdown of each pillar score, and disqualification_reason, the disqualifiers behind a DQ tier. Set include_score_details: false to leave them out.

Security
authorization
Bodyapplication/jsonrequired

Score Request

companiesobjectrequired

Filter companies by IDs or domains (mutually exclusive)

Example:
{
  "ids": [
    "E48EDEB162A5FBFDAF2DCF707079F8F",
    "1698C53EBC888758570396E0334965C1"
  ]
}
include_score_detailsboolean

Include fit_score_details, need_score_details and intent_score_details on each row. Also includes disqualification_reason. Set to false for a lighter response with only the scores.

Default:true
model_idsArray of strings, [ 1 .. 6 ] items

Model ids from GET /v2/scoring/models. Omit to score against every live model; if the organization has more than 6, naming them is required.

Example:
[
  "7e347cba"
]
curl -i -X POST \
  https://api.hginsights.com/data-api/v2/companies/score \
  -H 'Authorization: Bearer <YOUR_API_KEY_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "companies": {
      "ids": [
        "E48EDEB162A5FBFDAF2DCF707079F8F"
      ]
    },
    "model_ids": [
      "7e347cba"
    ]
  }'

Responses

Score Response

Bodyapplication/json
countintegerrequired

Number of rows returned

Example:0
scoresArray of objectsrequired
Example:
[]
Response
{
  "count": 0,
  "scores": []
}