Skip to content
/
Product installs

Product installs

Request

Retrieve a list of technologies (and corresponding details) which a company has been detected to have used or 'installed'.

It's also possible to specify what fields from the API should be returned. By default, only some fields are returned.

Security
authorization
Bodyapplication/jsonrequired

Company Installs Request

fieldsArray of strings or null(SelectedInstallFields)

List of fields to be selected.

Default:["product_id","product_name","vendor_name","product_last_verified_date","product_intensity","country_code"]
Items Enum:"product_id""product_name""product_description""vendor_id""vendor_name""vendor_domain_name""product_category_id""product_category_level1_name""product_category_level2_name""product_category_level3_name"
filtersobject(InstallsFilters)required

Filter Product Installs by various criteria. Must provide either company_id OR company_ids, but not both.

Example:
{
  "company_id": "1698C53EBC888758570396E0334965C1",
  "country_codes": {
    "ids": [ … ],
    "inclusion_method": "ANY_PRESENT"
  },
  "product_attributes": {
    "ids": [ … ],
    "inclusion_method": "ANY_PRESENT"
  },
  "product_categories": {
    "ids": [ … ],
    "inclusion_method": "ANY_PRESENT"
  },
  "products": {
    "ids": [ … ],
    "inclusion_method": "ANY_PRESENT"
  },
  "vendors": {
    "ids": [ … ],
    "inclusion_method": "ANY_PRESENT",
    "product_count": { … }
  }
}
limitinteger, <= 1000(Limit)

The number of records to return in the request.

Default:10
offsetinteger, >= 0(Offset)

Used for paginating records.

Default:0
sortsArray of objects(InstallFieldSorts)
Default:[{"direction":"DESC","field":"product_intensity"}]
Example:
[
  {
    "direction": "DESC",
    "field": "product_id"
  }
]
curl -i -X POST \
  https://api.hginsights.com/data-api/v1/company/installs \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "fields": [
      "product_id",
      "product_name",
      "vendor_name",
      "product_last_verified_date",
      "product_intensity",
      "country_code"
    ],
    "filters": {
      "company_id": "1698C53EBC888758570396E0334965C1",
      "country_codes": {
        "ids": [
          "US"
        ],
        "inclusion_method": "ANY_PRESENT"
      },
      "product_attributes": {
        "ids": [
          222
        ],
        "inclusion_method": "ANY_PRESENT"
      },
      "product_categories": {
        "ids": [
          "319D067B229178F03BCFA1DA4AC4DEDE"
        ],
        "inclusion_method": "ANY_PRESENT"
      },
      "products": {
        "ids": [
          814
        ],
        "inclusion_method": "ANY_PRESENT"
      },
      "vendors": {
        "ids": [
          316
        ],
        "inclusion_method": "ANY_PRESENT",
        "product_count": {
          "max": 10,
          "min": 1
        }
      }
    },
    "limit": 10,
    "offset": 0,
    "sorts": [
      {
        "direction": "DESC",
        "field": "product_intensity"
      }
    ]
  }'

Responses

Company Installs Response

Bodyapplication/json
countinteger

The number of installs at the company fitting the criteria.

dataArray of objects(InstallObject)
Response
{
  "count": 0,
  "data": [
    { … }
  ]
}