Skip to main content

Get Product Attribute

Coming soon

The v2 MCP API is in preview and not yet generally available. These pages document its tools and request/response shapes; live data access is limited to enrolled organizations until v2 is released.

Resolve HG Insights product-attribute IDs from a search theme. Attributes are the cross-cutting capability tags of the product taxonomy (e.g. 'Cloud Computing', 'Security', 'Software as a Service (SaaS)', 'Open Source') — the semantic layer above individual products. This is a taxonomy lookup, NOT a per-product attribute reader: there is no product_id input; it returns global taxonomy rows, not the attributes attached to one product, and never returns which companies carry an attribute. Free — no credits consumed. Search by attributeName for a case-insensitive substring match (relevance-ranked), or pass known attributeIds to fetch specific rows in one call. Provide at least one. Returns rows with attribute_id, attribute_name, attribute_description (a paragraph of context, populated for most attributes though occasionally empty), attribute_parent_id (0 = root theme, otherwise the id of the parent attribute), attribute_level (1 = root theme, 2 = more specific sub-attribute), and product_count (how many products carry the attribute — a rough breadth signal), plus a top-level count (total matches before pagination). The taxonomy is hierarchical: a search like 'Cloud' returns both the root 'Cloud Computing' (level 1) and its children (e.g. 'Cloud Workloads', level 2). Use this when you have a broad capability/theme and need the attribute_id(s) to feed as a filter into product or install tools (e.g. product_search_and_enrich, company_technographic). Browse by searching a broad attributeName — do NOT enumerate IDs sequentially. Do NOT use this to resolve a named product category — use get_product_category for taxonomy categories. Do NOT use this to resolve or look up a vendor/company — use get_vendor_information.

Parameters

NameTypeRequiredDefaultDescription
attributeNamestring❌ No-Free-text capability theme to search attribute names by. Case-insensitive substring match on attribute_name (LIKE) that activates relevance ranking. Pass a short capability keyword, not a full product or company name, e.g. 'SaaS', 'Open Source', 'Cloud', 'Security'. A broad term also matches sub-attributes (e.g. 'Cloud' → 'Cloud Computing' and its children like 'Cloud Workloads').
attributeIdsarray❌ No-Fetch specific attributes by their known attribute_ids (from a prior search), returning all matching rows in one call. Use this to re-hydrate ids into names/descriptions; do not guess or enumerate ids sequentially to browse the catalog — search by attributeName instead.
sortBystring❌ NorelevanceSort order: 'relevance' (best name match first — only meaningful with attributeName; the default), 'attribute_name' (alphabetical A→Z), or 'product_count' (most-used attributes first, useful for finding the broadest themes). On an id-only call the default 'relevance' falls back to the API's own ordering.
limitinteger❌ No10Maximum number of attribute rows to return (1–50, default 10). A broad theme can match dozens of attributes; raise this to survey a theme's full sub-hierarchy.
offsetinteger❌ No0Zero-based pagination offset (default 0). Combine with limit to page through matches when count exceeds the rows already returned.

Required Integrations

  • hginsights_v2__data_api

Use Cases

  • Find the attribute_id for a capability theme before filtering a product search — e.g. resolve 'SaaS' or 'Security'
  • Survey a theme's sub-hierarchy — search a broad term (e.g. 'Cloud') and read the root plus its child attributes
  • Rank attributes by breadth — sort by product_count to find the most widely-carried themes
  • Re-hydrate known attribute_ids back into names and descriptions in a single call
  • Read an attribute's description paragraph to confirm it matches the user's intended capability

Example Usage

Resolve the SaaS attribute by name

{
"tool": "get_product_attribute",
"arguments": {
"attributeName": "SaaS"
}
}

Survey the Cloud theme, broadest first

{
"tool": "get_product_attribute",
"arguments": {
"attributeName": "Cloud",
"sortBy": "product_count",
"limit": 15
}
}

Re-hydrate specific attribute ids

{
"tool": "get_product_attribute",
"arguments": {
"attributeIds": [
891,
224
]
}
}

get_product_category, get_vendor_information, product_search_and_enrich, company_technographic