Skip to content

Estimate Credits for Company Intent Signals

Request

Returns a credits estimate for an intent enrich request without consuming credits. Provides a breakdown by topics and activities.

Security
authorization
Bodyapplication/jsonrequired

Intent Estimate Request

companyobjectrequired

Company identifier. Provide exactly one of id or domain.

Example:
{
  "domain": "microsoft.com"
}
fieldsArray of strings

Which response sections to include.

Default:["summary","topics","activities"]
Items Enum:"summary""topics""activities"
Example:
[
  "summary",
  "topics",
  "activities"
]
filtersobject

Optional filters to narrow intent results.

Example:
{
  "activities": {
    "product_category_ids": [ … ]
  },
  "signal_date": {
    "max": "2026-12-31",
    "min": "2023-01-01"
  },
  "topics": {
    "buyers_journey_names": [ … ],
    "context_type_names": [ … ],
    "signal_level": [ … ]
  },
  "vendor_ids": [
    311
  ]
}
limitinteger, [ 1 .. 200 ]

Maximum number of records per section

Default:50
Example:50
offsetinteger, >= 0

Number of records to skip per section

Default:0
Example:0
curl -i -X POST \
  https://api.hginsights.com/data-api/v2/intent/enrich/estimate \
  -H 'Authorization: Bearer <YOUR_API_KEY_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "company": {
      "domain": "microsoft.com"
    },
    "fields": [
      "summary",
      "topics",
      "activities"
    ],
    "filters": {
      "signal_date": {
        "max": "2026-12-31",
        "min": "2023-01-01"
      },
      "topics": {
        "signal_level": [
          "HIGH"
        ]
      },
      "vendor_ids": [
        311
      ]
    },
    "limit": 50,
    "offset": 0
  }'

Responses

Intent Estimate Response

Bodyapplication/json
available_creditsintegerrequired

Credits currently available to the organization

Example:1000
credits_estimatenumber, (double)required

Estimated credits required to fulfill the request

Example:15
detailsobject or null

Per-section credit breakdown

Example:
{
  "activities": {
    "credits": 5
  },
  "topics": {
    "credits": 10
  }
}
sufficient_creditsbooleanrequired

Whether available credits cover the estimate

Example:true
Response
{
  "available_credits": 1000,
  "credits_estimate": 15,
  "details": {
    "activities": { … },
    "topics": { … }
  },
  "sufficient_credits": true
}