Get Product Attribute

get_product_attribute — resolve / search capability-theme attribute IDs from the HG Insights taxonomy. Attributes are cross-cutting capability tags (e.g. 'Cloud Computing', 'Security', 'SaaS', 'Open Source') — the semantic layer above individual products. This is a taxonomy lookup, NOT a per-product attribute reader: no product_id input; returns global taxonomy rows, not attributes attached to one product, and never returns which companies carry an attribute. Free — no credits consumed. Search by attributeName (case-insensitive substring, relevance-ranked) or pass known attributeIds to fetch specific rows. Provide at least one. Returns rows: attribute_id, attribute_name, attribute_description, attribute_parent_id (0 = root theme), attribute_level (1 = root, 2 = sub), product_count (breadth signal); plus top-level count. Taxonomy is hierarchical: 'Cloud' → root 'Cloud Computing' (level 1) plus children like 'Cloud Workloads' (level 2). Use when you need attribute_id(s) to filter product_search_and_enrich or company_technographic. Browse by searching a broad attributeName — do NOT enumerate IDs sequentially. Do NOT use to resolve a product category — use get_product_category. Do NOT use to resolve a vendor/company — use get_vendor_information.

Credits

Free — No credits consumed. See the full credit table for how AI Credits work.

Parameters

Name	Type	Default	Description
attributeName	string	-	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').
attributeIds	array	-	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.
sort_by	string	relevance	Sort 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.
limit	integer	10	Maximum 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.
offset	integer	0	Zero-based pagination offset (default 0). Combine with limit to page through matches when count exceeds the rows already returned.

Required Integrations

This tool is only available when your organization has the following integration configured in the HG Insights Integrations settings:

• HG Insights (Data API) (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",
    "sort_by": "product_count",
    "limit": 15
  }
}

Re-hydrate specific attribute ids

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

Response Format

Field	Type	Description
attributes	array	Matching attribute rows, ordered by sort_by.
attributes[].attribute_id	integer	Use this ID in downstream tool calls.
attributes[].attribute_name	string
attributes[].attribute_description	string | null
attributes[].attribute_parent_id	integer | null	0 = root-level attribute with no parent.
attributes[].attribute_level	integer | null
attributes[].product_count	integer | null
count	integer	Total matching attributes before pagination.

Related Tools

get_product_category, get_vendor_information, product_search_and_enrich, company_technographic