Company Functional Area Intelligence

Request

Returns Functional Area Intelligence (FAI) for a company. FAI predicts where detected technologies are used at both a departmental and location-specific level within an organization.

Provide the company by id (hex-encoded) or domain. All filters are optional.

Security

authorization

Bodyapplication/jsonrequired

FAI Request

companyobjectrequired

Company identifier. Provide exactly one of id or domain.

Example:

{
  "domain": "microsoft.com"
}

filtersobject

Optional filters to narrow FAI results.

Example:

{
  "departments": {
    "ids": [ … ]
  },
  "products": {
    "ids": [ … ]
  },
  "vendors": {
    "ids": [ … ]
  }
}

limitinteger, [ 1 .. 1000 ]

Maximum number of records to return

Default:100

Example:100

offsetinteger, >= 0

Number of records to skip

Default:0

Example:0

sortsArray of objects

Sort order for results

Default:[]

Example:

[
  {
    "direction": "DESC",
    "field": "department_usage_share"
  }
]

curl -i -X POST \
  https://api.hginsights.com/data-api/v2/companies/functional-areas \
  -H 'Authorization: Bearer <YOUR_API_KEY_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "company": {
      "domain": "microsoft.com"
    },
    "filters": {
      "departments": {
        "ids": [
          "3570470BAD94692CE93E32700D2E1CB"
        ]
      },
      "products": {
        "ids": [
          814
        ]
      },
      "vendors": {
        "ids": [
          311,
          466
        ]
      }
    },
    "limit": 100,
    "offset": 0,
    "sorts": [
      {
        "direction": "DESC",
        "field": "department_usage_share"
      }
    ]
  }'

Responses

FAI Response

Bodyapplication/json

companyobject or null

Company information extracted from FAI data.

Example:

{
  "domain": "microsoft.com",
  "id": "1698C53EBC888758570396E0334965C1",
  "name": "Microsoft"
}

countintegerrequired

Total number of matching records (before pagination)

Example:42

dataArray of objectsrequired

FAI data records

Example:

[
  {
    "country_name": "United States",
    "department_id": "3570470BAD94692CE93E32700D2E1CB",
    "department_name": "Engineering",
    "department_signal_strength": 12,
    "department_usage_share": 0.45,
    "has_decision_maker": true,
    "has_influencer": false,
    "product_id": 814,
    "product_name": "Oracle Java",
    "role_name": "Software Engineer",
    "vendor_id": 311,
    "vendor_name": "Oracle"
  }
]

Response

{
  "company": {
    "domain": "microsoft.com",
    "id": "1698C53EBC888758570396E0334965C1",
    "name": "Microsoft"
  },
  "count": 42,
  "data": [
    { … }
  ]
}