List all FAI departments
License HG Insights terms of service
The HG Insights API provides comprehensive, data-driven insights into global technology markets and company landscapes. This API can be leveraged to seamlessly integrate HG’s firmographic and technographic data into platforms and internal processes.
Today, the API allows you to search our database of entities, understand our catalog of filters and products, and enrich firmographic and install data by HG ID.
This endpoint is to help make sure you have the correctly formatted inputs in other calls. This is an important resource that should be used to make sure parameters of other endpoints lead to successful calls.
Closely review the ReDoc/Swagger before making these calls, as some require additional inputs in the query parameters.
This catalog will generate lists for the following areas of the product:
This endpoint allows you to find entities in our dataset by name, country and/or URL.
Some entities can return a number of records back due to areas of deep location granularity in our data set. As a result, we allow you to return between 1 and 10 possible matches based on your input.
This endpoint will return the HG ID, Name and URL back to you for matching records. HG ID will be an important parameter in firmographic and install endpoints.
This endpoint allows you to find companies based on our wide variety of search criteria.
We’ll return back to you the count of companies that match your criteria, as well as an array of Name, Domain, Domain Normalized and HG ID. The array will be limited based on the value set in the request. HG ID will be an important parameter in firmographic and install endpoints.
Pay careful attention to the request body scheme to ensure a successful call. We highly recommend consulting the data catalog endpoint for help exploring options and selecting the right syntax.
This endpoint allows the user to retrieve firmographic information about a company. Response will cover all fields available in the Platform today, including firmographics for both the target company and the GHQ.
An HG ID must be included in the parameter for this call to be successful, and the call will return data for that single HG ID.
This endpoint allows the user to retrieve product install information about a company.
Filter your request by specific product datapoints relating to the id, name, vendor and category details, along with localization of the install.
An HG ID must be included in the parameter for this call to be successful, and the call will return data for that single HG ID.
This endpoint allows the user to retrieve IT Spend Budget data about a company.
Requests can be filtered to only specific IT Spend Budget categories, or all categories can be returned in the call.
An HG ID must be included in the parameter for this call to be successful, and the call will return data for that single HG ID.
HG Insights’ Functional Area Intelligence solution predicts where detected technologies are used on both a departmental and location-specific level within an organization. Given a product in a department, we will return top locations where a Decision Maker or Influencer is present.
An HG ID, product(s) and department(s) must be included in the parameter for this call to be successful, you may also optionally include roles to further target the returned data. The call will return data for that single HG ID.
HG Contextual Intent is a solution designed for companies looking to leverage the power of customer buying patterns. This intent data is then contextualized with each company’s technographic profile to provide refined insights that support laser-focused company targeting.
A HG ID must be included in the parameter for this call to be successful, and the call will return data for that single HG ID. Requests can be filtered to only specific Intent topics, or all provisioned topics can be returned in the call. Available intent topics are limited to those provisioned to your organization.
The API is structured around REST commands with HTTPS response codes to indicate either successful calls or errors produced. Responses are all JSON objects.
When making API requests in URL, you must do so over HTTPS - calls made over HTTP will fail.
Some endpoints, especially the ones inside our Data Catalog can return a lot of data. To reduce the data transfer and increase response time, the client should use the Content-Encoding header and specify a compression method, like gzip.
To access our data, you will need a token - this is a small piece of code that verifies a user or application to access an API. This token is needed for all API endpoints.
Does the token rotate?: This token will be refreshed periodically and should be used in the request header to authenticate the request.
How to Obtain a Token: This token will be supplied to you via your CSM.
Security Best Practices: Keep your API token confidential and regenerate tokens if compromised. Use HTTPS for all API requests
The API uses standard HTTP status codes to indicate the success or failure of a request.
| Code | Description | Notes |
|---|---|---|
| 200 | OK | |
| 401 | Unauthorized | Probably a missing token or an invalid token |
| 404 | Not found | The requested resource was not found |
| 422 | Unprocessable Entity | Most likely the request body is invalid because of missing or invalid parameters validated by the Open API Spec |
curl -i -X GET \
https://api.hginsights.com/data-api/v1/catalog/fai_departments \
-H 'Authorization: YOUR_API_KEY_HERE'{ "count": 1, "data": [ { … } ] }
Company FAI Request
List of fields to be selected.
Filters to be used to narrow down the functional area intelligence data to return.
A unique hexadecimal identifier for the desired field.
A unique hexadecimal identifier for the desired field.
A unique hexadecimal identifier for the desired field.
Return functional area intelligence records which are based on the provided department ids.
A unique hexadecimal identifier for the desired field.
A unique hexadecimal identifier for the desired field.
Return functional area intelligence records which are based on the provided product ids.
Return functional area intelligence records which are based on the provided department role ids.
curl -i -X POST \
https://api.hginsights.com/data-api/v1/company/functional_area_intelligence \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"fields": [
"company_id",
"product_name",
"department_name",
"role_name"
],
"filters": {
"company_id": "0252985AFE13886BC6FFA5CEBD75F4FA",
"departments": [
"0D32106BCB6DE321930CF34574EA388C",
"3D4C638DA5F85D025963F99FE90B1B1A",
"2C329EF27D7F8CB49D656D5502B9E939"
],
"products": [
1150,
805,
25421,
826,
814,
562
],
"roles": [
"2AB3F09BBBA80FF82B8FD5916954C46A",
"2E6BAB5FC1C661EDD7A863D4DCA3415B",
"21C896AFCD34E446180844D91359246E",
"39FD56FC1455D4D872DB14F656225740"
]
}
}'{ "count": 0, "data": [ { … } ] }