{"items":[{"type":"link","label":"HG Insights API V1","link":"/v1/openapi","routeSlug":"/v1/openapi","content":{"contentType":"overview","meta":{"name":"HG Insights API V1"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/v1/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/v1/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"HG Insights terms of service","url":"https://hginsights.com/contact-hg/terms-of-service"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.hginsights.com","variables":{}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"HG Insights API V1","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/v1/openapi"}],"sectionId":"/v1/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/overview-of-the-hg-insights-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of the HG Insights API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For new integrations, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/v2/openapi"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HG Insights API V2"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]}],"sectionId":"/v1/openapi/section/overview-of-the-hg-insights-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/summary-of-endpoints"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Summary of Endpoints"},"children":[]}]}]}]}],"sectionId":"/v1/openapi/section/summary-of-endpoints"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/summary-of-endpoints/data-catalog-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Catalog API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Closely review the ReDoc/Swagger before making these calls, as some require additional inputs in the query parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This catalog will generate lists for the following areas of the product:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Countries"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAI Departments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAI Roles"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Industries"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intent Buyers Journey"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intent Context Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intent Topics"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NAICS 2012"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Attributes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Categories"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Products"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIC"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spend Categories"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"States"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vendors"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/v1/openapi/catalog"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Catalog"},"children":[]}]}]}]}]}],"sectionId":"/v1/openapi/section/summary-of-endpoints/data-catalog-api"}],"sectionId":"/v1/openapi/section/summary-of-endpoints/data-catalog-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/summary-of-endpoints/company-match-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Match API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to find entities in our dataset by name, country and/or URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/v1/openapi/company/find_companies"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Match API"},"children":[]}]}]}]}]}],"sectionId":"/v1/openapi/section/summary-of-endpoints/company-match-api"}],"sectionId":"/v1/openapi/section/summary-of-endpoints/company-match-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/summary-of-endpoints/company-search-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Search API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to find companies based on our wide variety of search criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/v1/openapi/company/search_companies"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Search API"},"children":[]}]}]}]}]}],"sectionId":"/v1/openapi/section/summary-of-endpoints/company-search-api"}],"sectionId":"/v1/openapi/section/summary-of-endpoints/company-search-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/summary-of-endpoints/company-firmographics-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Firmographics API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/v1/openapi/company/company_info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Firmographics API"},"children":[]}]}]}]}]}],"sectionId":"/v1/openapi/section/summary-of-endpoints/company-firmographics-api"}],"sectionId":"/v1/openapi/section/summary-of-endpoints/company-firmographics-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/summary-of-endpoints/company-installs-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Installs API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows the user to retrieve product install information about a company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter your request by specific product datapoints relating to the id, name, vendor and category details, along with localization of the install."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/v1/openapi/company/company_installs"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Installs API"},"children":[]}]}]}]}]}],"sectionId":"/v1/openapi/section/summary-of-endpoints/company-installs-api"}],"sectionId":"/v1/openapi/section/summary-of-endpoints/company-installs-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/summary-of-endpoints/spend-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spend API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows the user to retrieve IT Spend Budget data about a company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests can be filtered to only specific IT Spend Budget categories, or all categories can be returned in the call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/v1/openapi/company/company_spend"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spend API"},"children":[]}]}]}]}]}],"sectionId":"/v1/openapi/section/summary-of-endpoints/spend-api"}],"sectionId":"/v1/openapi/section/summary-of-endpoints/spend-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/summary-of-endpoints/functional-area-intelligence"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Functional Area Intelligence"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/v1/openapi/company/company_fai"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Functional Area Intelligence API"},"children":[]}]}]}]}]}],"sectionId":"/v1/openapi/section/summary-of-endpoints/functional-area-intelligence"}],"sectionId":"/v1/openapi/section/summary-of-endpoints/functional-area-intelligence"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/summary-of-endpoints/intent-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intent API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]}],"sectionId":"/v1/openapi/section/summary-of-endpoints/intent-api"}],"sectionId":"/v1/openapi/section/summary-of-endpoints/intent-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/api-structure-+-base-url"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Structure + Base URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API is structured around REST commands with HTTPS response codes to indicate either successful calls or errors produced.  Responses are all JSON objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When making API requests in URL, you must do so over HTTPS - calls made over HTTP will fail."},"children":[]}]}]}]}],"sectionId":"/v1/openapi/section/api-structure-+-base-url"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/note:-configuration-for-large-data-transfer"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Configuration for Large Data Transfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and specify a compression method, like gzip."},"children":[]}]}]}]}],"sectionId":"/v1/openapi/section/note:-configuration-for-large-data-transfer"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/tokens-and-authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokens & Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Does the token rotate?:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This token will be refreshed periodically and should be used in the request header to authenticate the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to Obtain a Token:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This token will be supplied to you via your CSM."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security Best Practices:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Keep your API token confidential and regenerate tokens if compromised.  Use HTTPS for all API requests"},"children":[]}]}]}]}],"sectionId":"/v1/openapi/section/tokens-and-authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/api-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Errors"},"children":[]}]}]}]}],"sectionId":"/v1/openapi/section/api-errors"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/api-errors/error-codes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API uses standard HTTP status codes to indicate the success or failure of a request."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Probably a missing token or an invalid token"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested resource was not found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Entity"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most likely the request body is invalid because of missing or invalid parameters validated by the Open API Spec"},"children":[]}]}]}]}]}]}]}],"sectionId":"/v1/openapi/section/api-errors/error-codes"}],"sectionId":"/v1/openapi/section/api-errors/error-codes"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/api-errors/error-messages"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error messages"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error messages follow always the same pattern for syntax errors:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"errors\": [\n    {\n      \"title\": \"Invalid request\",\n      \"detail\": \"The request is invalid\",\n      \"source\": {\n        \"pointer\": \"/data/attributes/first-name\"\n      }\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"errors\": [\n    {\n      \"title\": \"Invalid request\",\n      \"detail\": \"The request is invalid\",\n      \"source\": {\n        \"pointer\": \"/data/attributes/first-name\"\n      }\n    }\n  ]\n}\n"},"children":[]}]}]}],"sectionId":"/v1/openapi/section/api-errors/error-messages"}],"sectionId":"/v1/openapi/section/api-errors/error-messages"}]}]}},{"type":"link","label":"Overview of the HG Insights API","link":"/v1/openapi/section/overview-of-the-hg-insights-api","routeSlug":"/v1/openapi/section/overview-of-the-hg-insights-api","content":null},{"type":"group","label":"Summary of Endpoints","link":"/v1/openapi/section/summary-of-endpoints","routeSlug":"/v1/openapi/section/summary-of-endpoints","items":[{"type":"link","label":"Data Catalog API","link":"/v1/openapi/section/summary-of-endpoints/data-catalog-api","routeSlug":"/v1/openapi/section/summary-of-endpoints/data-catalog-api","content":null},{"type":"link","label":"Company Match API","link":"/v1/openapi/section/summary-of-endpoints/company-match-api","routeSlug":"/v1/openapi/section/summary-of-endpoints/company-match-api","content":null},{"type":"link","label":"Company Search API","link":"/v1/openapi/section/summary-of-endpoints/company-search-api","routeSlug":"/v1/openapi/section/summary-of-endpoints/company-search-api","content":null},{"type":"link","label":"Company Firmographics API","link":"/v1/openapi/section/summary-of-endpoints/company-firmographics-api","routeSlug":"/v1/openapi/section/summary-of-endpoints/company-firmographics-api","content":null},{"type":"link","label":"Company Installs API","link":"/v1/openapi/section/summary-of-endpoints/company-installs-api","routeSlug":"/v1/openapi/section/summary-of-endpoints/company-installs-api","content":null},{"type":"link","label":"Spend API","link":"/v1/openapi/section/summary-of-endpoints/spend-api","routeSlug":"/v1/openapi/section/summary-of-endpoints/spend-api","content":null},{"type":"link","label":"Functional Area Intelligence","link":"/v1/openapi/section/summary-of-endpoints/functional-area-intelligence","routeSlug":"/v1/openapi/section/summary-of-endpoints/functional-area-intelligence","content":null},{"type":"link","label":"Intent API","link":"/v1/openapi/section/summary-of-endpoints/intent-api","routeSlug":"/v1/openapi/section/summary-of-endpoints/intent-api","content":null}],"content":null},{"type":"link","label":"API Structure + Base URL","link":"/v1/openapi/section/api-structure-+-base-url","routeSlug":"/v1/openapi/section/api-structure-+-base-url","content":null},{"type":"link","label":"Note: Configuration for Large Data Transfer","link":"/v1/openapi/section/note:-configuration-for-large-data-transfer","routeSlug":"/v1/openapi/section/note:-configuration-for-large-data-transfer","content":null},{"type":"link","label":"Tokens & Authentication","link":"/v1/openapi/section/tokens-and-authentication","routeSlug":"/v1/openapi/section/tokens-and-authentication","content":null},{"type":"group","label":"API Errors","link":"/v1/openapi/section/api-errors","routeSlug":"/v1/openapi/section/api-errors","items":[{"type":"link","label":"Error Codes","link":"/v1/openapi/section/api-errors/error-codes","routeSlug":"/v1/openapi/section/api-errors/error-codes","content":null},{"type":"link","label":"Error messages","link":"/v1/openapi/section/api-errors/error-messages","routeSlug":"/v1/openapi/section/api-errors/error-messages","content":null}],"content":null},{"type":"separator","label":"API endpoints by context","content":null},{"type":"group","label":"Geography","link":"/v1/openapi/geography","routeSlug":"/v1/openapi/geography","items":[{"label":"List countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/geography/list_countries","routeSlug":"/v1/openapi/geography/list_countries","metadata":{"seo":{"title":"List countries","description":"List all countries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_countries","name":"List countries","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1countries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List countries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all countries"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/countries","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/countries","href":"geography/list_countries","openApiOperationId":"list_countries","summary":"List countries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Countries","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CountriesResponse"}},"schemaId":"components/schemas/CountriesResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1countries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CountriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CountriesResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/geography/list_countries"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/countries"},{"label":"List states","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/geography/list_states","routeSlug":"/v1/openapi/geography/list_states","metadata":{"seo":{"title":"List states","description":"List all states"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_states","name":"List states","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1states/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List states","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all states"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/states","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/states","href":"geography/list_states","openApiOperationId":"list_states","summary":"List states"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"States","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatesResponse"}},"schemaId":"components/schemas/StatesResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1states/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatesResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/geography/list_states"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/states"}],"content":{"contentType":"group","meta":{"name":"Geography"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Geography","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v1/catalog/countries","summary":"List countries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/geography/list_countries","deprecated":false},{"title":"/data-api/v1/catalog/states","summary":"List states","prefix":{"name":"get","color":"get"},"badges":[],"link":"/geography/list_states","deprecated":false}]}]}]}]}},{"type":"group","label":"Industry","link":"/v1/openapi/industry","routeSlug":"/v1/openapi/industry","items":[{"label":"List industries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/industry/list_industries","routeSlug":"/v1/openapi/industry/list_industries","metadata":{"seo":{"title":"List industries","description":"List all industries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_industries","name":"List industries","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1industries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List industries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all industries"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/industries","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/industries","href":"industry/list_industries","openApiOperationId":"list_industries","summary":"List industries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Industries","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IndustryResponse"}},"schemaId":"components/schemas/IndustryResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1industries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IndustryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IndustryResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/industry/list_industries"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/industries"},{"label":"List NAICS 2012","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/industry/list_naics2012","routeSlug":"/v1/openapi/industry/list_naics2012","metadata":{"seo":{"title":"List NAICS 2012","description":"List all NAICS 2012"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_naics2012","name":"List NAICS 2012","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1naics2012/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List NAICS 2012","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all NAICS 2012"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/naics2012","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/naics2012","href":"industry/list_naics2012","openApiOperationId":"list_naics2012","summary":"List NAICS 2012"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"NAICS 2012","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NAICS2012Response"}},"schemaId":"components/schemas/NAICS2012Response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1naics2012/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NAICS2012Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NAICS2012Response"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/industry/list_naics2012"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/naics2012"},{"label":"List SIC US 1987","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/industry/list_sicus1987","routeSlug":"/v1/openapi/industry/list_sicus1987","metadata":{"seo":{"title":"List SIC US 1987","description":"List all SIC US 1987"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_sicus1987","name":"List SIC US 1987","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1sicus1987/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List SIC US 1987","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all SIC US 1987"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/sicus1987","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/sicus1987","href":"industry/list_sicus1987","openApiOperationId":"list_sicus1987","summary":"List SIC US 1987"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"SIC US 1987","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SICUS1987Response"}},"schemaId":"components/schemas/SICUS1987Response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1sicus1987/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SICUS1987Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SICUS1987Response"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/industry/list_sicus1987"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/sicus1987"}],"content":{"contentType":"group","meta":{"name":"Industry"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Industry","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v1/catalog/industries","summary":"List industries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/industry/list_industries","deprecated":false},{"title":"/data-api/v1/catalog/naics2012","summary":"List NAICS 2012","prefix":{"name":"get","color":"get"},"badges":[],"link":"/industry/list_naics2012","deprecated":false},{"title":"/data-api/v1/catalog/sicus1987","summary":"List SIC US 1987","prefix":{"name":"get","color":"get"},"badges":[],"link":"/industry/list_sicus1987","deprecated":false}]}]}]}]}},{"type":"group","label":"Technographic","link":"/v1/openapi/technographic","routeSlug":"/v1/openapi/technographic","items":[{"label":"List products attributes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/technographic/list_product_attributes","routeSlug":"/v1/openapi/technographic/list_product_attributes","metadata":{"seo":{"title":"List products attributes","description":"List all products attributes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_product_attributes","name":"List products attributes","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1product_attributes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List products attributes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all products attributes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/product_attributes","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/product_attributes","href":"technographic/list_product_attributes","openApiOperationId":"list_product_attributes","summary":"List products attributes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Products Attributtes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductAttributesResponse"}},"schemaId":"components/schemas/ProductAttributesResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1product_attributes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductAttributesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductAttributesResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/technographic/list_product_attributes"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/product_attributes"},{"label":"List product categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/technographic/list_product_categories","routeSlug":"/v1/openapi/technographic/list_product_categories","metadata":{"seo":{"title":"List product categories","description":"List all product categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_product_categories","name":"List product categories","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1product_categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List product categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all product categories"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/product_categories","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/product_categories","href":"technographic/list_product_categories","openApiOperationId":"list_product_categories","summary":"List product categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product Categories","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCategoriesResponse"}},"schemaId":"components/schemas/ProductCategoriesResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1product_categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductCategoriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCategoriesResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/technographic/list_product_categories"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/product_categories"},{"label":"List products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/technographic/list_products","routeSlug":"/v1/openapi/technographic/list_products","metadata":{"seo":{"title":"List products","description":"List all products"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_products","name":"List products","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all products"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/products","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/products","href":"technographic/list_products","openApiOperationId":"list_products","summary":"List products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Products","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductsResponse"}},"schemaId":"components/schemas/ProductsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1products/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductsResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/technographic/list_products"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/products"},{"label":"List vendors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/technographic/list_vendors","routeSlug":"/v1/openapi/technographic/list_vendors","metadata":{"seo":{"title":"List vendors","description":"List vendors by search term"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_vendors","name":"List vendors","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1vendors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List vendors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List vendors by search term"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_15","description":"Vendor name"}],"pointer":"/paths/~1data-api~1v1~1catalog~1vendors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/vendors","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":false,"example":"Ford","schemaId":"schema_15"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/vendors","href":"technographic/list_vendors","openApiOperationId":"list_vendors","summary":"List vendors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Vendors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VendorsResponse"}},"schemaId":"components/schemas/VendorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1vendors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VendorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VendorsResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/technographic/list_vendors"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/vendors"},{"label":"Product installs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/technographic/company_installs","routeSlug":"/v1/openapi/technographic/company_installs","metadata":{"seo":{"title":"Product installs","description":"Retrieve a list of technologies (and corresponding details) which a company has been detected to have used or 'installed'."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"company_installs","name":"Product installs","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1installs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product installs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of technologies (and corresponding details) which a company has been detected to have used or 'installed'.\n\nIt's also possible to specify what fields from the API should be returned. By default, only some fields are returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInstallsRequest"}},"schemaId":"components/schemas/CompanyInstallsRequest","pointer":"/paths/~1data-api~1v1~1company~1installs/post/requestBody","description":"Company Installs Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v1/company/installs","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyInstallsRequest"}},"responseCodes":["200","401","404","422"],"pointer":"/data-api/v1/company/installs","href":"technographic/company_installs","openApiOperationId":"company_installs","summary":"Product installs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompanyInstallsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInstallsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Company Installs Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyInstallsResponse"}},"schemaId":"components/schemas/CompanyInstallsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}},"schemaId":"components/schemas/NotFoundResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1installs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyInstallsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyInstallsResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/NotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/technographic/company_installs"}],"panels":[]}]},"httpPath":"/data-api/v1/company/installs"}],"content":{"contentType":"group","meta":{"name":"Technographic"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Technographic","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v1/catalog/product_attributes","summary":"List products attributes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/technographic/list_product_attributes","deprecated":false},{"title":"/data-api/v1/catalog/product_categories","summary":"List product categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/technographic/list_product_categories","deprecated":false},{"title":"/data-api/v1/catalog/products","summary":"List products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/technographic/list_products","deprecated":false},{"title":"/data-api/v1/catalog/vendors","summary":"List vendors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/technographic/list_vendors","deprecated":false},{"title":"/data-api/v1/company/installs","summary":"Product installs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/technographic/company_installs","deprecated":false}]}]}]}]}},{"type":"group","label":"Intent","link":"/v1/openapi/intent","routeSlug":"/v1/openapi/intent","items":[{"label":"List intent buyers journey","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/intent/list_intent_buyers_journey","routeSlug":"/v1/openapi/intent/list_intent_buyers_journey","metadata":{"seo":{"title":"List intent buyers journey","description":"List all intent buyers journey"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_intent_buyers_journey","name":"List intent buyers journey","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1intent_buyers_journey/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List intent buyers journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all intent buyers journey"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/intent_buyers_journey","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/intent_buyers_journey","href":"intent/list_intent_buyers_journey","openApiOperationId":"list_intent_buyers_journey","summary":"List intent buyers journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Intent buyers journey","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentBuyersJourneyResponse"}},"schemaId":"components/schemas/IntentBuyersJourneyResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1intent_buyers_journey/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IntentBuyersJourneyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentBuyersJourneyResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/intent/list_intent_buyers_journey"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/intent_buyers_journey"},{"label":"List intent context types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/intent/list_intent_context_types","routeSlug":"/v1/openapi/intent/list_intent_context_types","metadata":{"seo":{"title":"List intent context types","description":"List all intent context types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_intent_context_types","name":"List intent context types","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1intent_context_types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List intent context types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all intent context types"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/intent_context_types","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/intent_context_types","href":"intent/list_intent_context_types","openApiOperationId":"list_intent_context_types","summary":"List intent context types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Intent context types","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentContextTypesResponse"}},"schemaId":"components/schemas/IntentContextTypesResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1intent_context_types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IntentContextTypesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentContextTypesResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/intent/list_intent_context_types"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/intent_context_types"},{"label":"List intent topics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/intent/list_intent_topics","routeSlug":"/v1/openapi/intent/list_intent_topics","metadata":{"seo":{"title":"List intent topics","description":"List all intent topics"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_intent_topics","name":"List intent topics","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1intent_topics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List intent topics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all intent topics"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/intent_topics","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/intent_topics","href":"intent/list_intent_topics","openApiOperationId":"list_intent_topics","summary":"List intent topics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Intent topics","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentTopicsResponse"}},"schemaId":"components/schemas/IntentTopicsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1intent_topics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IntentTopicsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentTopicsResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/intent/list_intent_topics"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/intent_topics"},{"label":"List provisioned intent topics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/intent/list_provisioned_intent_topics","routeSlug":"/v1/openapi/intent/list_provisioned_intent_topics","metadata":{"seo":{"title":"List provisioned intent topics","description":"List all intent topics which are provisioned for the user's organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_provisioned_intent_topics","name":"List provisioned intent topics","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1provisioned_intent_topics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List provisioned intent topics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all intent topics which are provisioned for the user's organization"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/provisioned_intent_topics","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/provisioned_intent_topics","href":"intent/list_provisioned_intent_topics","openApiOperationId":"list_provisioned_intent_topics","summary":"List provisioned intent topics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Provisioned intent topics","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentTopicsResponse"}},"schemaId":"components/schemas/IntentTopicsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1provisioned_intent_topics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IntentTopicsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentTopicsResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/intent/list_provisioned_intent_topics"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/provisioned_intent_topics"},{"label":"Company Intent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/intent/company_intent","routeSlug":"/v1/openapi/intent/company_intent","metadata":{"seo":{"title":"Company Intent","description":"Returns intent data about the specified company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"company_intent","name":"Company Intent","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1intent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Intent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns intent data about the specified company.\n\nIt's also possible to specify what fields from the API should be returned. By default, only some fields are returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyIntentRequest"}},"schemaId":"components/schemas/CompanyIntentRequest","pointer":"/paths/~1data-api~1v1~1company~1intent/post/requestBody","description":"Company Intent Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v1/company/intent","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyIntentRequest"}},"responseCodes":["200","401","422"],"pointer":"/data-api/v1/company/intent","href":"intent/company_intent","openApiOperationId":"company_intent","summary":"Company Intent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompanyIntentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyIntentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Company Intent Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyIntentResponse"}},"schemaId":"components/schemas/CompanyIntentResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1intent/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyIntentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyIntentResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/intent/company_intent"}],"panels":[]}]},"httpPath":"/data-api/v1/company/intent"}],"content":{"contentType":"group","meta":{"name":"Intent"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Intent","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v1/catalog/intent_buyers_journey","summary":"List intent buyers journey","prefix":{"name":"get","color":"get"},"badges":[],"link":"/intent/list_intent_buyers_journey","deprecated":false},{"title":"/data-api/v1/catalog/intent_context_types","summary":"List intent context types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/intent/list_intent_context_types","deprecated":false},{"title":"/data-api/v1/catalog/intent_topics","summary":"List intent topics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/intent/list_intent_topics","deprecated":false},{"title":"/data-api/v1/catalog/provisioned_intent_topics","summary":"List provisioned intent topics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/intent/list_provisioned_intent_topics","deprecated":false},{"title":"/data-api/v1/company/intent","summary":"Company Intent","prefix":{"name":"post","color":"post"},"badges":[],"link":"/intent/company_intent","deprecated":false}]}]}]}]}},{"type":"group","label":"FAI","link":"/v1/openapi/fai","routeSlug":"/v1/openapi/fai","items":[{"label":"List FAI departments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/fai/list_fai_departments","routeSlug":"/v1/openapi/fai/list_fai_departments","metadata":{"seo":{"title":"List FAI departments","description":"List all FAI departments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_fai_departments","name":"List FAI departments","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1fai_departments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List FAI departments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all FAI departments"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/fai_departments","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/fai_departments","href":"fai/list_fai_departments","openApiOperationId":"list_fai_departments","summary":"List FAI departments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"FAI departments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FAIDepartmentResponse"}},"schemaId":"components/schemas/FAIDepartmentResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1fai_departments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FAIDepartmentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FAIDepartmentResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fai/list_fai_departments"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/fai_departments"},{"label":"Functional Area Intelligence","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/fai/company_fai","routeSlug":"/v1/openapi/fai/company_fai","metadata":{"seo":{"title":"Functional Area Intelligence","description":"Lookup functional area intelligence data for a company based on a company's ID, products, departments, and roles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"company_fai","name":"Functional Area Intelligence","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1functional_area_intelligence/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Functional Area Intelligence","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lookup functional area intelligence data for a company based on a company's ID, products, departments, and roles.\n\nResults have an internal limit of 10.\n\nIt's also possible to specify what fields from the API should be returned. By default, only some fields are returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyFaiRequest"}},"schemaId":"components/schemas/CompanyFaiRequest","pointer":"/paths/~1data-api~1v1~1company~1functional_area_intelligence/post/requestBody","description":"Company FAI Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v1/company/functional_area_intelligence","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyFaiRequest"}},"responseCodes":["200","401","404","422"],"pointer":"/data-api/v1/company/functional_area_intelligence","href":"fai/company_fai","openApiOperationId":"company_fai","summary":"Functional Area Intelligence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompanyFaiRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyFaiRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Company FAI Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyFaiResponse"}},"schemaId":"components/schemas/CompanyFaiResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}},"schemaId":"components/schemas/NotFoundResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1functional_area_intelligence/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyFaiResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyFaiResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/NotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fai/company_fai"}],"panels":[]}]},"httpPath":"/data-api/v1/company/functional_area_intelligence"}],"content":{"contentType":"group","meta":{"name":"FAI"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FAI","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v1/catalog/fai_departments","summary":"List FAI departments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fai/list_fai_departments","deprecated":false},{"title":"/data-api/v1/company/functional_area_intelligence","summary":"Functional Area Intelligence","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fai/company_fai","deprecated":false}]}]}]}]}},{"type":"group","label":"Companies","link":"/v1/openapi/companies","routeSlug":"/v1/openapi/companies","items":[{"label":"Firmographic","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/companies/company_info","routeSlug":"/v1/openapi/companies/company_info","metadata":{"seo":{"title":"Firmographic","description":"Returns detailed information about the specified company, including firmographics, installed technologies, and more."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"company_info","name":"Firmographic","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1firmographic/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Firmographic","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns detailed information about the specified company, including firmographics, installed technologies, and more.\n\nResults are internally sorted by revenue (descending).\n\nIt's also possible to specify what fields from the API should be returned. By default, only some fields are returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInfoRequest"}},"schemaId":"components/schemas/CompanyInfoRequest","pointer":"/paths/~1data-api~1v1~1company~1firmographic/post/requestBody","description":"Company Info Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v1/company/firmographic","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyInfoRequest"}},"responseCodes":["200","401","404","422"],"pointer":"/data-api/v1/company/firmographic","href":"companies/company_info","openApiOperationId":"company_info","summary":"Firmographic"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompanyInfoRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInfoRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Company Info Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyInfoResponse"}},"schemaId":"components/schemas/CompanyInfoResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}},"schemaId":"components/schemas/NotFoundResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1firmographic/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyInfoResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyInfoResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/NotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/company_info"}],"panels":[]}]},"httpPath":"/data-api/v1/company/firmographic"},{"label":"Firmographics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/companies/companies_info","routeSlug":"/v1/openapi/companies/companies_info","metadata":{"seo":{"title":"Firmographics","description":"Returns detailed information about the specified companies, including firmographics, installed technologies, and more."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companies_info","name":"Firmographics","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1firmographics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Firmographics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns detailed information about the specified companies, including firmographics, installed technologies, and more.\n\nResults are internally sorted by revenue (descending).\n\nIt's also possible to specify what fields from the API should be returned. By default, only some fields are returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInfoListRequest"}},"schemaId":"components/schemas/CompanyInfoListRequest","pointer":"/paths/~1data-api~1v1~1company~1firmographics/post/requestBody","description":"Company Info List Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v1/company/firmographics","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyInfoListRequest"}},"responseCodes":["200","401","404","422"],"pointer":"/data-api/v1/company/firmographics","href":"companies/companies_info","openApiOperationId":"companies_info","summary":"Firmographics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompanyInfoListRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInfoListRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Company Info List Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyInfoListResponse"}},"schemaId":"components/schemas/CompanyInfoListResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}},"schemaId":"components/schemas/NotFoundResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1firmographics/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyInfoListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyInfoListResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/NotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/companies_info"}],"panels":[]}]},"httpPath":"/data-api/v1/company/firmographics"},{"label":"Match Companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/companies/find_companies","routeSlug":"/v1/openapi/companies/find_companies","metadata":{"seo":{"title":"Match Companies","description":"Match to HG companies by company name, country code and/or domain URL."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"find_companies","name":"Match Companies","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1match/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Match Companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Match to HG companies by company name, country code and/or domain URL.\n\nLimited to maximum of 10 companies and sorted by relevance and revenue.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"company_name","in":"query","schemaId":"schema_16","description":"Name of the company to search for."},{"name":"country_code","in":"query","schemaId":"schema_17","description":"The country where the company's global headquarters resides. Can be a country name or an ISO 3166 alpha-2 code."},{"name":"domain_name","in":"query","schemaId":"schema_18","description":"The domain URL associated with the company."},{"name":"limit","in":"query","schemaId":"schema_19","description":"The limit of results to be returned. Default of 10."}],"pointer":"/paths/~1data-api~1v1~1company~1match/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/company/match","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"company_name","in":"query","required":false,"example":"Ford Motor Company","schemaId":"schema_16"},{"name":"country_code","in":"query","required":false,"example":"United States","schemaId":"schema_17"},{"name":"domain_name","in":"query","required":false,"example":"ford.com","schemaId":"schema_18"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/company/match","href":"companies/find_companies","openApiOperationId":"find_companies","summary":"Match Companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Companies","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FindCompaniesResponse"}},"schemaId":"components/schemas/FindCompaniesResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1match/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FindCompaniesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FindCompaniesResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/find_companies"}],"panels":[]}]},"httpPath":"/data-api/v1/company/match"},{"label":"Search & Filter Companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/companies/search_companies","routeSlug":"/v1/openapi/companies/search_companies","metadata":{"seo":{"title":"Search & Filter Companies","description":"Retrieve a list of companies and their corresponding details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_companies","name":"Search & Filter Companies","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search & Filter Companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of companies and their corresponding details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanySearchRequest"}},"schemaId":"components/schemas/CompanySearchRequest","pointer":"/paths/~1data-api~1v1~1company~1search/post/requestBody","description":"Search for companies"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v1/company/search","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanySearchRequest"}},"responseCodes":["200","401","404","422"],"pointer":"/data-api/v1/company/search","href":"companies/search_companies","openApiOperationId":"search_companies","summary":"Search & Filter Companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompanySearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanySearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Search Companies Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanySearchResponse"}},"schemaId":"components/schemas/CompanySearchResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}},"schemaId":"components/schemas/NotFoundResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanySearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanySearchResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/NotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/search_companies"}],"panels":[]}]},"httpPath":"/data-api/v1/company/search"}],"content":{"contentType":"group","meta":{"name":"Companies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Companies","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v1/company/firmographic","summary":"Firmographic","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/company_info","deprecated":false},{"title":"/data-api/v1/company/firmographics","summary":"Firmographics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/companies_info","deprecated":false},{"title":"/data-api/v1/company/match","summary":"Match Companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/find_companies","deprecated":false},{"title":"/data-api/v1/company/search","summary":"Search & Filter Companies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/search_companies","deprecated":false}]}]}]}]}},{"type":"group","label":"Spend","link":"/v1/openapi/spend","routeSlug":"/v1/openapi/spend","items":[{"label":"List spend categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/spend/list_spend_categories","routeSlug":"/v1/openapi/spend/list_spend_categories","metadata":{"seo":{"title":"List spend categories","description":"List all spend categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_spend_categories","name":"List spend categories","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1spend_categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List spend categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all spend categories"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/spend_categories","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/spend_categories","href":"spend/list_spend_categories","openApiOperationId":"list_spend_categories","summary":"List spend categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Spend categories","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpendCategoriesResponse"}},"schemaId":"components/schemas/SpendCategoriesResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1spend_categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SpendCategoriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpendCategoriesResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend/list_spend_categories"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/spend_categories"},{"label":"Spend","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/spend/company_spend","routeSlug":"/v1/openapi/spend/company_spend","metadata":{"seo":{"title":"Spend","description":"Returns spend data about the specified company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"company_spend","name":"Spend","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1spend/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Spend","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns spend data about the specified company.\n\nIt's also possible to specify what fields from the API should be returned. By default, only some fields are returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanySpendRequest"}},"schemaId":"components/schemas/CompanySpendRequest","pointer":"/paths/~1data-api~1v1~1company~1spend/post/requestBody","description":"Company Spend Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v1/company/spend","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanySpendRequest"}},"responseCodes":["200","401","422"],"pointer":"/data-api/v1/company/spend","href":"spend/company_spend","openApiOperationId":"company_spend","summary":"Spend"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompanySpendRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanySpendRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Company Spend Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanySpendResponse"}},"schemaId":"components/schemas/CompanySpendResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1spend/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanySpendResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanySpendResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend/company_spend"}],"panels":[]}]},"httpPath":"/data-api/v1/company/spend"}],"content":{"contentType":"group","meta":{"name":"Spend"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Spend","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v1/catalog/spend_categories","summary":"List spend categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/spend/list_spend_categories","deprecated":false},{"title":"/data-api/v1/company/spend","summary":"Spend","prefix":{"name":"post","color":"post"},"badges":[],"link":"/spend/company_spend","deprecated":false}]}]}]}]}},{"type":"separator","label":"API endpoints by type","content":null},{"type":"group","label":"Catalog","link":"/v1/openapi/catalog","routeSlug":"/v1/openapi/catalog","items":[{"label":"List countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_countries","routeSlug":"/v1/openapi/catalog/list_countries","metadata":{"seo":{"title":"List countries","description":"List all countries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_countries","name":"List countries","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1countries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List countries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all countries"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/countries","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/countries","href":"catalog/list_countries","openApiOperationId":"list_countries","summary":"List countries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Countries","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CountriesResponse"}},"schemaId":"components/schemas/CountriesResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1countries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CountriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CountriesResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_countries"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/countries"},{"label":"List FAI departments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_fai_departments","routeSlug":"/v1/openapi/catalog/list_fai_departments","metadata":{"seo":{"title":"List FAI departments","description":"List all FAI departments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_fai_departments","name":"List FAI departments","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1fai_departments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List FAI departments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all FAI departments"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/fai_departments","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/fai_departments","href":"catalog/list_fai_departments","openApiOperationId":"list_fai_departments","summary":"List FAI departments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"FAI departments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FAIDepartmentResponse"}},"schemaId":"components/schemas/FAIDepartmentResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1fai_departments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FAIDepartmentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FAIDepartmentResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_fai_departments"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/fai_departments"},{"label":"List industries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_industries","routeSlug":"/v1/openapi/catalog/list_industries","metadata":{"seo":{"title":"List industries","description":"List all industries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_industries","name":"List industries","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1industries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List industries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all industries"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/industries","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/industries","href":"catalog/list_industries","openApiOperationId":"list_industries","summary":"List industries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Industries","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IndustryResponse"}},"schemaId":"components/schemas/IndustryResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1industries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IndustryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IndustryResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_industries"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/industries"},{"label":"List intent buyers journey","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_intent_buyers_journey","routeSlug":"/v1/openapi/catalog/list_intent_buyers_journey","metadata":{"seo":{"title":"List intent buyers journey","description":"List all intent buyers journey"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_intent_buyers_journey","name":"List intent buyers journey","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1intent_buyers_journey/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List intent buyers journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all intent buyers journey"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/intent_buyers_journey","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/intent_buyers_journey","href":"catalog/list_intent_buyers_journey","openApiOperationId":"list_intent_buyers_journey","summary":"List intent buyers journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Intent buyers journey","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentBuyersJourneyResponse"}},"schemaId":"components/schemas/IntentBuyersJourneyResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1intent_buyers_journey/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IntentBuyersJourneyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentBuyersJourneyResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_intent_buyers_journey"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/intent_buyers_journey"},{"label":"List intent context types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_intent_context_types","routeSlug":"/v1/openapi/catalog/list_intent_context_types","metadata":{"seo":{"title":"List intent context types","description":"List all intent context types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_intent_context_types","name":"List intent context types","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1intent_context_types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List intent context types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all intent context types"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/intent_context_types","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/intent_context_types","href":"catalog/list_intent_context_types","openApiOperationId":"list_intent_context_types","summary":"List intent context types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Intent context types","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentContextTypesResponse"}},"schemaId":"components/schemas/IntentContextTypesResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1intent_context_types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IntentContextTypesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentContextTypesResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_intent_context_types"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/intent_context_types"},{"label":"List intent topics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_intent_topics","routeSlug":"/v1/openapi/catalog/list_intent_topics","metadata":{"seo":{"title":"List intent topics","description":"List all intent topics"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_intent_topics","name":"List intent topics","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1intent_topics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List intent topics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all intent topics"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/intent_topics","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/intent_topics","href":"catalog/list_intent_topics","openApiOperationId":"list_intent_topics","summary":"List intent topics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Intent topics","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentTopicsResponse"}},"schemaId":"components/schemas/IntentTopicsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1intent_topics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IntentTopicsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentTopicsResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_intent_topics"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/intent_topics"},{"label":"List NAICS 2012","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_naics2012","routeSlug":"/v1/openapi/catalog/list_naics2012","metadata":{"seo":{"title":"List NAICS 2012","description":"List all NAICS 2012"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_naics2012","name":"List NAICS 2012","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1naics2012/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List NAICS 2012","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all NAICS 2012"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/naics2012","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/naics2012","href":"catalog/list_naics2012","openApiOperationId":"list_naics2012","summary":"List NAICS 2012"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"NAICS 2012","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NAICS2012Response"}},"schemaId":"components/schemas/NAICS2012Response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1naics2012/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NAICS2012Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NAICS2012Response"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_naics2012"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/naics2012"},{"label":"List products attributes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_product_attributes","routeSlug":"/v1/openapi/catalog/list_product_attributes","metadata":{"seo":{"title":"List products attributes","description":"List all products attributes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_product_attributes","name":"List products attributes","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1product_attributes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List products attributes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all products attributes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/product_attributes","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/product_attributes","href":"catalog/list_product_attributes","openApiOperationId":"list_product_attributes","summary":"List products attributes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Products Attributtes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductAttributesResponse"}},"schemaId":"components/schemas/ProductAttributesResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1product_attributes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductAttributesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductAttributesResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_product_attributes"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/product_attributes"},{"label":"List product categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_product_categories","routeSlug":"/v1/openapi/catalog/list_product_categories","metadata":{"seo":{"title":"List product categories","description":"List all product categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_product_categories","name":"List product categories","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1product_categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List product categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all product categories"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/product_categories","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/product_categories","href":"catalog/list_product_categories","openApiOperationId":"list_product_categories","summary":"List product categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product Categories","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCategoriesResponse"}},"schemaId":"components/schemas/ProductCategoriesResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1product_categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductCategoriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCategoriesResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_product_categories"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/product_categories"},{"label":"List products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_products","routeSlug":"/v1/openapi/catalog/list_products","metadata":{"seo":{"title":"List products","description":"List all products"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_products","name":"List products","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all products"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/products","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/products","href":"catalog/list_products","openApiOperationId":"list_products","summary":"List products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Products","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductsResponse"}},"schemaId":"components/schemas/ProductsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1products/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductsResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_products"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/products"},{"label":"List provisioned intent topics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_provisioned_intent_topics","routeSlug":"/v1/openapi/catalog/list_provisioned_intent_topics","metadata":{"seo":{"title":"List provisioned intent topics","description":"List all intent topics which are provisioned for the user's organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_provisioned_intent_topics","name":"List provisioned intent topics","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1provisioned_intent_topics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List provisioned intent topics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all intent topics which are provisioned for the user's organization"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/provisioned_intent_topics","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/provisioned_intent_topics","href":"catalog/list_provisioned_intent_topics","openApiOperationId":"list_provisioned_intent_topics","summary":"List provisioned intent topics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Provisioned intent topics","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentTopicsResponse"}},"schemaId":"components/schemas/IntentTopicsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1provisioned_intent_topics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IntentTopicsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentTopicsResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_provisioned_intent_topics"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/provisioned_intent_topics"},{"label":"List SIC US 1987","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_sicus1987","routeSlug":"/v1/openapi/catalog/list_sicus1987","metadata":{"seo":{"title":"List SIC US 1987","description":"List all SIC US 1987"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_sicus1987","name":"List SIC US 1987","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1sicus1987/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List SIC US 1987","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all SIC US 1987"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/sicus1987","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/sicus1987","href":"catalog/list_sicus1987","openApiOperationId":"list_sicus1987","summary":"List SIC US 1987"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"SIC US 1987","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SICUS1987Response"}},"schemaId":"components/schemas/SICUS1987Response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1sicus1987/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SICUS1987Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SICUS1987Response"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_sicus1987"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/sicus1987"},{"label":"List spend categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_spend_categories","routeSlug":"/v1/openapi/catalog/list_spend_categories","metadata":{"seo":{"title":"List spend categories","description":"List all spend categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_spend_categories","name":"List spend categories","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1spend_categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List spend categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all spend categories"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/spend_categories","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/spend_categories","href":"catalog/list_spend_categories","openApiOperationId":"list_spend_categories","summary":"List spend categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Spend categories","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpendCategoriesResponse"}},"schemaId":"components/schemas/SpendCategoriesResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1spend_categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SpendCategoriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpendCategoriesResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_spend_categories"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/spend_categories"},{"label":"List states","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_states","routeSlug":"/v1/openapi/catalog/list_states","metadata":{"seo":{"title":"List states","description":"List all states"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_states","name":"List states","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1states/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List states","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all states"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/states","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/states","href":"catalog/list_states","openApiOperationId":"list_states","summary":"List states"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"States","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatesResponse"}},"schemaId":"components/schemas/StatesResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1states/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatesResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_states"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/states"},{"label":"List vendors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/catalog/list_vendors","routeSlug":"/v1/openapi/catalog/list_vendors","metadata":{"seo":{"title":"List vendors","description":"List vendors by search term"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_vendors","name":"List vendors","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1catalog~1vendors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List vendors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List vendors by search term"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_15","description":"Vendor name"}],"pointer":"/paths/~1data-api~1v1~1catalog~1vendors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/catalog/vendors","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":false,"example":"Ford","schemaId":"schema_15"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/catalog/vendors","href":"catalog/list_vendors","openApiOperationId":"list_vendors","summary":"List vendors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Vendors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VendorsResponse"}},"schemaId":"components/schemas/VendorsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1catalog~1vendors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VendorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VendorsResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/list_vendors"}],"panels":[]}]},"httpPath":"/data-api/v1/catalog/vendors"}],"content":{"contentType":"group","meta":{"name":"Catalog"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Catalog","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v1/catalog/countries","summary":"List countries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_countries","deprecated":false},{"title":"/data-api/v1/catalog/fai_departments","summary":"List FAI departments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_fai_departments","deprecated":false},{"title":"/data-api/v1/catalog/industries","summary":"List industries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_industries","deprecated":false},{"title":"/data-api/v1/catalog/intent_buyers_journey","summary":"List intent buyers journey","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_intent_buyers_journey","deprecated":false},{"title":"/data-api/v1/catalog/intent_context_types","summary":"List intent context types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_intent_context_types","deprecated":false},{"title":"/data-api/v1/catalog/intent_topics","summary":"List intent topics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_intent_topics","deprecated":false},{"title":"/data-api/v1/catalog/naics2012","summary":"List NAICS 2012","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_naics2012","deprecated":false},{"title":"/data-api/v1/catalog/product_attributes","summary":"List products attributes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_product_attributes","deprecated":false},{"title":"/data-api/v1/catalog/product_categories","summary":"List product categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_product_categories","deprecated":false},{"title":"/data-api/v1/catalog/products","summary":"List products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_products","deprecated":false},{"title":"/data-api/v1/catalog/provisioned_intent_topics","summary":"List provisioned intent topics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_provisioned_intent_topics","deprecated":false},{"title":"/data-api/v1/catalog/sicus1987","summary":"List SIC US 1987","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_sicus1987","deprecated":false},{"title":"/data-api/v1/catalog/spend_categories","summary":"List spend categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_spend_categories","deprecated":false},{"title":"/data-api/v1/catalog/states","summary":"List states","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_states","deprecated":false},{"title":"/data-api/v1/catalog/vendors","summary":"List vendors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/list_vendors","deprecated":false}]}]}]}]}},{"type":"group","label":"Company","link":"/v1/openapi/company","routeSlug":"/v1/openapi/company","items":[{"label":"Firmographic","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/company/company_info","routeSlug":"/v1/openapi/company/company_info","metadata":{"seo":{"title":"Firmographic","description":"Returns detailed information about the specified company, including firmographics, installed technologies, and more."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"company_info","name":"Firmographic","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1firmographic/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Firmographic","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns detailed information about the specified company, including firmographics, installed technologies, and more.\n\nResults are internally sorted by revenue (descending).\n\nIt's also possible to specify what fields from the API should be returned. By default, only some fields are returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInfoRequest"}},"schemaId":"components/schemas/CompanyInfoRequest","pointer":"/paths/~1data-api~1v1~1company~1firmographic/post/requestBody","description":"Company Info Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v1/company/firmographic","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyInfoRequest"}},"responseCodes":["200","401","404","422"],"pointer":"/data-api/v1/company/firmographic","href":"company/company_info","openApiOperationId":"company_info","summary":"Firmographic"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompanyInfoRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInfoRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Company Info Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyInfoResponse"}},"schemaId":"components/schemas/CompanyInfoResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}},"schemaId":"components/schemas/NotFoundResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1firmographic/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyInfoResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyInfoResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/NotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/company_info"}],"panels":[]}]},"httpPath":"/data-api/v1/company/firmographic"},{"label":"Firmographics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/company/companies_info","routeSlug":"/v1/openapi/company/companies_info","metadata":{"seo":{"title":"Firmographics","description":"Returns detailed information about the specified companies, including firmographics, installed technologies, and more."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companies_info","name":"Firmographics","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1firmographics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Firmographics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns detailed information about the specified companies, including firmographics, installed technologies, and more.\n\nResults are internally sorted by revenue (descending).\n\nIt's also possible to specify what fields from the API should be returned. By default, only some fields are returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInfoListRequest"}},"schemaId":"components/schemas/CompanyInfoListRequest","pointer":"/paths/~1data-api~1v1~1company~1firmographics/post/requestBody","description":"Company Info List Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v1/company/firmographics","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyInfoListRequest"}},"responseCodes":["200","401","404","422"],"pointer":"/data-api/v1/company/firmographics","href":"company/companies_info","openApiOperationId":"companies_info","summary":"Firmographics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompanyInfoListRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInfoListRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Company Info List Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyInfoListResponse"}},"schemaId":"components/schemas/CompanyInfoListResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}},"schemaId":"components/schemas/NotFoundResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1firmographics/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyInfoListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyInfoListResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/NotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/companies_info"}],"panels":[]}]},"httpPath":"/data-api/v1/company/firmographics"},{"label":"Functional Area Intelligence","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/company/company_fai","routeSlug":"/v1/openapi/company/company_fai","metadata":{"seo":{"title":"Functional Area Intelligence","description":"Lookup functional area intelligence data for a company based on a company's ID, products, departments, and roles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"company_fai","name":"Functional Area Intelligence","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1functional_area_intelligence/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Functional Area Intelligence","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lookup functional area intelligence data for a company based on a company's ID, products, departments, and roles.\n\nResults have an internal limit of 10.\n\nIt's also possible to specify what fields from the API should be returned. By default, only some fields are returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyFaiRequest"}},"schemaId":"components/schemas/CompanyFaiRequest","pointer":"/paths/~1data-api~1v1~1company~1functional_area_intelligence/post/requestBody","description":"Company FAI Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v1/company/functional_area_intelligence","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyFaiRequest"}},"responseCodes":["200","401","404","422"],"pointer":"/data-api/v1/company/functional_area_intelligence","href":"company/company_fai","openApiOperationId":"company_fai","summary":"Functional Area Intelligence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompanyFaiRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyFaiRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Company FAI Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyFaiResponse"}},"schemaId":"components/schemas/CompanyFaiResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}},"schemaId":"components/schemas/NotFoundResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1functional_area_intelligence/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyFaiResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyFaiResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/NotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/company_fai"}],"panels":[]}]},"httpPath":"/data-api/v1/company/functional_area_intelligence"},{"label":"Product installs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/company/company_installs","routeSlug":"/v1/openapi/company/company_installs","metadata":{"seo":{"title":"Product installs","description":"Retrieve a list of technologies (and corresponding details) which a company has been detected to have used or 'installed'."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"company_installs","name":"Product installs","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1installs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product installs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of technologies (and corresponding details) which a company has been detected to have used or 'installed'.\n\nIt's also possible to specify what fields from the API should be returned. By default, only some fields are returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInstallsRequest"}},"schemaId":"components/schemas/CompanyInstallsRequest","pointer":"/paths/~1data-api~1v1~1company~1installs/post/requestBody","description":"Company Installs Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v1/company/installs","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyInstallsRequest"}},"responseCodes":["200","401","404","422"],"pointer":"/data-api/v1/company/installs","href":"company/company_installs","openApiOperationId":"company_installs","summary":"Product installs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompanyInstallsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInstallsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Company Installs Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyInstallsResponse"}},"schemaId":"components/schemas/CompanyInstallsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}},"schemaId":"components/schemas/NotFoundResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1installs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyInstallsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyInstallsResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/NotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/company_installs"}],"panels":[]}]},"httpPath":"/data-api/v1/company/installs"},{"label":"Company Intent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/company/company_intent","routeSlug":"/v1/openapi/company/company_intent","metadata":{"seo":{"title":"Company Intent","description":"Returns intent data about the specified company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"company_intent","name":"Company Intent","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1intent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Intent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns intent data about the specified company.\n\nIt's also possible to specify what fields from the API should be returned. By default, only some fields are returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyIntentRequest"}},"schemaId":"components/schemas/CompanyIntentRequest","pointer":"/paths/~1data-api~1v1~1company~1intent/post/requestBody","description":"Company Intent Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v1/company/intent","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyIntentRequest"}},"responseCodes":["200","401","422"],"pointer":"/data-api/v1/company/intent","href":"company/company_intent","openApiOperationId":"company_intent","summary":"Company Intent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompanyIntentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyIntentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Company Intent Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyIntentResponse"}},"schemaId":"components/schemas/CompanyIntentResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1intent/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyIntentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyIntentResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/company_intent"}],"panels":[]}]},"httpPath":"/data-api/v1/company/intent"},{"label":"Match Companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/company/find_companies","routeSlug":"/v1/openapi/company/find_companies","metadata":{"seo":{"title":"Match Companies","description":"Match to HG companies by company name, country code and/or domain URL."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"find_companies","name":"Match Companies","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1match/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Match Companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Match to HG companies by company name, country code and/or domain URL.\n\nLimited to maximum of 10 companies and sorted by relevance and revenue.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"company_name","in":"query","schemaId":"schema_16","description":"Name of the company to search for."},{"name":"country_code","in":"query","schemaId":"schema_17","description":"The country where the company's global headquarters resides. Can be a country name or an ISO 3166 alpha-2 code."},{"name":"domain_name","in":"query","schemaId":"schema_18","description":"The domain URL associated with the company."},{"name":"limit","in":"query","schemaId":"schema_19","description":"The limit of results to be returned. Default of 10."}],"pointer":"/paths/~1data-api~1v1~1company~1match/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v1/company/match","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"company_name","in":"query","required":false,"example":"Ford Motor Company","schemaId":"schema_16"},{"name":"country_code","in":"query","required":false,"example":"United States","schemaId":"schema_17"},{"name":"domain_name","in":"query","required":false,"example":"ford.com","schemaId":"schema_18"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v1/company/match","href":"company/find_companies","openApiOperationId":"find_companies","summary":"Match Companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Companies","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FindCompaniesResponse"}},"schemaId":"components/schemas/FindCompaniesResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1match/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FindCompaniesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FindCompaniesResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/find_companies"}],"panels":[]}]},"httpPath":"/data-api/v1/company/match"},{"label":"Search & Filter Companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/company/search_companies","routeSlug":"/v1/openapi/company/search_companies","metadata":{"seo":{"title":"Search & Filter Companies","description":"Retrieve a list of companies and their corresponding details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_companies","name":"Search & Filter Companies","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search & Filter Companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of companies and their corresponding details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanySearchRequest"}},"schemaId":"components/schemas/CompanySearchRequest","pointer":"/paths/~1data-api~1v1~1company~1search/post/requestBody","description":"Search for companies"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v1/company/search","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanySearchRequest"}},"responseCodes":["200","401","404","422"],"pointer":"/data-api/v1/company/search","href":"company/search_companies","openApiOperationId":"search_companies","summary":"Search & Filter Companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompanySearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanySearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Search Companies Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanySearchResponse"}},"schemaId":"components/schemas/CompanySearchResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}},"schemaId":"components/schemas/NotFoundResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanySearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanySearchResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/NotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/search_companies"}],"panels":[]}]},"httpPath":"/data-api/v1/company/search"},{"label":"Spend","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/company/company_spend","routeSlug":"/v1/openapi/company/company_spend","metadata":{"seo":{"title":"Spend","description":"Returns spend data about the specified company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"company_spend","name":"Spend","isWebhook":false,"pointer":"/paths/~1data-api~1v1~1company~1spend/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Spend","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns spend data about the specified company.\n\nIt's also possible to specify what fields from the API should be returned. By default, only some fields are returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanySpendRequest"}},"schemaId":"components/schemas/CompanySpendRequest","pointer":"/paths/~1data-api~1v1~1company~1spend/post/requestBody","description":"Company Spend Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v1/company/spend","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanySpendRequest"}},"responseCodes":["200","401","422"],"pointer":"/data-api/v1/company/spend","href":"company/company_spend","openApiOperationId":"company_spend","summary":"Spend"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompanySpendRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanySpendRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Company Spend Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanySpendResponse"}},"schemaId":"components/schemas/CompanySpendResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}},"schemaId":"components/schemas/JsonErrorResponse"}],"pointer":"/paths/~1data-api~1v1~1company~1spend/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanySpendResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanySpendResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"422","schemaId":"components/schemas/JsonErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/company_spend"}],"panels":[]}]},"httpPath":"/data-api/v1/company/spend"}],"content":{"contentType":"group","meta":{"name":"Company"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v1/company/firmographic","summary":"Firmographic","prefix":{"name":"post","color":"post"},"badges":[],"link":"/company/company_info","deprecated":false},{"title":"/data-api/v1/company/firmographics","summary":"Firmographics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/company/companies_info","deprecated":false},{"title":"/data-api/v1/company/functional_area_intelligence","summary":"Functional Area Intelligence","prefix":{"name":"post","color":"post"},"badges":[],"link":"/company/company_fai","deprecated":false},{"title":"/data-api/v1/company/installs","summary":"Product installs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/company/company_installs","deprecated":false},{"title":"/data-api/v1/company/intent","summary":"Company Intent","prefix":{"name":"post","color":"post"},"badges":[],"link":"/company/company_intent","deprecated":false},{"title":"/data-api/v1/company/match","summary":"Match Companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/company/find_companies","deprecated":false},{"title":"/data-api/v1/company/search","summary":"Search & Filter Companies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/company/search_companies","deprecated":false},{"title":"/data-api/v1/company/spend","summary":"Spend","prefix":{"name":"post","color":"post"},"badges":[],"link":"/company/company_spend","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CompanyObject":{"id":"components/schemas/CompanyObject","kind":"json-schema","title":"CompanyObject","data":{"properties":{"naics_name":{"type":"string","x-struct":null,"x-validate":null},"global_hq_sic_codes":{"items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"global_hq_country_code":{"type":"string","x-struct":null,"x-validate":null},"naics_code":{"type":"string","x-struct":null,"x-validate":null},"revenue_total":{"description":"Revenue in USD","nullable":true,"type":"integer","x-struct":null,"x-validate":null},"fortune_500_rank":{"minimum":1,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"global_hq_country_name":{"type":"string","x-struct":null,"x-validate":null},"global_hq_industry_name":{"type":"string","x-struct":null,"x-validate":null},"global_hq_city_name":{"type":"string","x-struct":null,"x-validate":null},"subcontinent_name":{"type":"string","x-struct":null,"x-validate":null},"state_name":{"type":"string","x-struct":null,"x-validate":null},"company_level":{"type":"string","x-struct":null,"x-validate":null},"country_code":{"type":"string","x-struct":null,"x-validate":null},"global_hq_continent_name":{"type":"string","x-struct":null,"x-validate":null},"global_hq_domain_name":{"type":"string","x-struct":null,"x-validate":null},"employees_band":{"description":"Employees band","type":"string","x-struct":null,"x-validate":null},"global_hq_employees_band":{"type":"string","x-struct":null,"x-validate":null},"global_hq_revenue_band":{"type":"string","x-struct":null,"x-validate":null},"sic_codes":{"items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"global_hq_state_name":{"type":"string","x-struct":null,"x-validate":null},"industry_id":{"type":"integer","x-struct":null,"x-validate":null},"global_hq_fortune_500_rank":{"minimum":1,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"industry_name":{"type":"string","x-struct":null,"x-validate":null},"global_hq_naics_name":{"type":"string","x-struct":null,"x-validate":null},"postal_code":{"type":"string","x-struct":null,"x-validate":null},"global_hq_geopolitical_name":{"type":"string","x-struct":null,"x-validate":null},"employees_total":{"description":"Number of employees","nullable":true,"type":"integer","x-struct":null,"x-validate":null},"geopolitical_name":{"type":"string","x-struct":null,"x-validate":null},"global_hq_hg_id":{"type":"string","x-struct":null,"x-validate":null},"global_hq_industry_id":{"type":"integer","x-struct":null,"x-validate":null},"global_hq_subcontinent_name":{"type":"string","x-struct":null,"x-validate":null},"revenue_band":{"description":"Revenue band","type":"string","x-struct":null,"x-validate":null},"country_name":{"type":"string","x-struct":null,"x-validate":null},"forbes_2000_rank":{"minimum":1,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"global_hq_domain_name_normalized":{"type":"string","x-struct":null,"x-validate":null},"it_spend":{"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"global_hq_sic_names":{"items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"global_hq_forbes_2000_rank":{"minimum":1,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"global_hq_company_name":{"type":"string","x-struct":null,"x-validate":null},"continent_name":{"type":"string","x-struct":null,"x-validate":null},"sic_names":{"items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"global_hq_naics_code":{"type":"string","x-struct":null,"x-validate":null},"global_hq_postal_code":{"type":"integer","x-struct":null,"x-validate":null},"city_name":{"type":"string","x-struct":null,"x-validate":null}},"title":"CompanyObject","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Object","x-validate":null}},"components/schemas/RevenueFilter":{"id":"components/schemas/RevenueFilter","kind":"json-schema","title":"RevenueFilter","data":{"description":"Filter by the revenue earned by a company. Some companies are listed as having a single discrete revenue value, while others are listed as a range. By default this filter will match against both.","example":{"has_fixed_revenue":true,"max":50000000,"min":10000000},"properties":{"has_fixed_revenue":{"description":"Whether to limit the companies returned to those listed with a single/fixed revenue value (and exclude those listed as a range).","nullable":true,"type":"boolean","x-struct":null,"x-validate":null},"max":{"description":"The maximum revenue to match against.","minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"min":{"description":"The minimum revenue to match against.","minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null}},"title":"RevenueFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.Firmographics.RevenueFilter","x-validate":null}},"components/schemas/InstallFieldSorts":{"id":"components/schemas/InstallFieldSorts","kind":"json-schema","title":"InstallFieldSorts","data":{"default":[{"direction":"DESC","field":"product_intensity"}],"items":{"$ref":"#/components/schemas/SortedInstallField"},"title":"InstallFieldSorts","type":"array","x-struct":"Elixir.TalariaWeb.Schemas.V1.Install.Sorts","x-validate":null}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"description":"Product schema","example":{"childrenAttributes":[{"description":"Cloud Application Performance Management (or Cloud APM) software allows businesses to manage and monitor resources that provide support for cloud-based applications. Cloud APM software helps administrators identify, address, and resolve issues that impact both back-end functions (such as costs, security, resource availability, traffic, latency, or application errors) and end-user experiences. The goal of Cloud APM is to improve application responsiveness, uptime, and UX.","id":2,"level":2,"name":"Cloud Application Performance Management"}],"description":"Cloud Computing refers to the delivery of computing services (hardware and software) via public, private, or hybrid cloud environments. Cloud Computing software includes but is not limited to servers, software, storage, networking, analytics, cloud APM, cloud CPG, cost optimization, workload management, data security, IT operations, and development environments.","id":1,"level":1,"name":"Cloud Computing"},"properties":{"childrenAttributes":{"items":{"properties":{"description":{"description":"Product Attribute description","type":"string","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/Id"},"level":{"description":"Product Attribute level","type":"integer","x-struct":null,"x-validate":null},"name":{"description":"Product Attribute name","type":"string","x-struct":null,"x-validate":null}},"required":["description","id","level","name"],"type":"object","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"description":{"description":"Product Attribute description","type":"string","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/Id"},"level":{"description":"Product Attribute level","type":"integer","x-struct":null,"x-validate":null},"name":{"description":"Product Attribute name","type":"string","x-struct":null,"x-validate":null}},"required":["childrenAttributes","description","id","level","name"],"title":"Product","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.ProductAttributes.ProductAttribute","x-validate":null}},"components/schemas/MinMaxFilter":{"id":"components/schemas/MinMaxFilter","kind":"json-schema","title":"MinMaxFilter","data":{"description":"MinMax range filter object","example":{"max":50,"min":25},"properties":{"max":{"description":"Maximum value","minimum":0,"type":"integer","x-struct":null,"x-validate":null},"min":{"description":"Minimum value","minimum":0,"type":"integer","x-struct":null,"x-validate":null}},"required":["min","max"],"title":"MinMaxFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.MinMaxFilter","x-validate":null}},"components/schemas/IndustryResponse":{"id":"components/schemas/IndustryResponse","kind":"json-schema","title":"IndustryResponse","data":{"description":"Response schema for Industry","example":{"count":1,"data":[{"id":"63E88D6A88D45AB23B4CB4E71CB5A2E","name":"Foo Bar"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/Industry"},"type":"array","x-struct":null,"x-validate":null}},"title":"IndustryResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.Industries.Response","x-validate":null}},"components/schemas/CompanyInstallsRequest":{"id":"components/schemas/CompanyInstallsRequest","kind":"json-schema","title":"CompanyInstallsRequest","data":{"description":"A search query to get a list of installs for a company based on filter criteria.","properties":{"fields":{"$ref":"#/components/schemas/SelectedInstallFields"},"filters":{"$ref":"#/components/schemas/InstallsFilters"},"limit":{"$ref":"#/components/schemas/Limit"},"offset":{"$ref":"#/components/schemas/Offset"},"sorts":{"$ref":"#/components/schemas/InstallFieldSorts"}},"required":["filters"],"title":"CompanyInstallsRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Installs.Request","x-validate":null}},"components/schemas/VendorFilter":{"id":"components/schemas/VendorFilter","kind":"json-schema","title":"VendorFilter","data":{"allOf":[{"$ref":"#/components/schemas/AnyNoneNumericInclusionFilter"}],"description":"Filter by Vendor IDs","example":{"ids":[16994],"inclusion_method":"ANY_PRESENT"},"title":"VendorFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Install.Filters.VendorFilter","x-validate":null}},"components/schemas/Id":{"id":"components/schemas/Id","kind":"json-schema","title":"Id","data":{"description":"A unique hexadecimal identifier for the desired field.","example":"1698C53EBC888758570396E0334965C1","oneOf":[{"type":"string","x-struct":null,"x-validate":null},{"type":"integer","x-struct":null,"x-validate":null}],"title":"Id","x-struct":null,"x-validate":"Elixir.TalariaWeb.Schemas.Common.Id"}},"components/schemas/SpendFilter":{"id":"components/schemas/SpendFilter","kind":"json-schema","title":"SpendFilter","data":{"description":"Filter by USD spent by a company in certain categories.","example":{"categories":{"ids":["3B36D42E7F8E60BE58BA4356B6AF40C"],"inclusion_method":"ANY_PRESENT"},"range":{"min":2000000000}},"minProperties":2,"properties":{"categories":{"$ref":"#/components/schemas/AnyIdInclusionFilter"},"range":{"$ref":"#/components/schemas/RangeFilter"}},"required":["categories","range"],"title":"SpendFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.Spend.SpendFilter","x-validate":null}},"components/schemas/IntentSignalScoreFilter":{"id":"components/schemas/IntentSignalScoreFilter","kind":"json-schema","title":"IntentSignalScoreFilter","data":{"default":"HIGH","description":"Filter based on the signal score for an intent signal.\nAccepts either \"MEDIUM\" (from 65 to 84), and \"HIGH\" (from 85 to 100).\n","enum":["MEDIUM","HIGH"],"example":"MEDIUM","title":"IntentSignalScoreFilter","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.Intent.IntentSignalScoreFilter","x-validate":null}},"components/schemas/CompanySpendSortFields":{"id":"components/schemas/CompanySpendSortFields","kind":"json-schema","title":"CompanySpendSortFields","data":{"enum":["spend","category_id","country_code"],"title":"CompanySpendSortFields","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Spend.Sorts.SortFields","x-validate":null}},"components/schemas/AnyInclusionMethod":{"id":"components/schemas/AnyInclusionMethod","kind":"json-schema","title":"AnyInclusionMethod","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inclusion method for just ANY_PRESENT"},"children":[]}]}]}],"enum":["ANY_PRESENT"],"title":"AnyInclusionMethod","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.AnyInclusionMethod","x-validate":null}},"components/schemas/CompanySpendResponse":{"id":"components/schemas/CompanySpendResponse","kind":"json-schema","title":"CompanySpendResponse","data":{"description":"A list of spend data for a company and the full count of spend data.","properties":{"count":{"type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/SpendObject"},"type":"array","x-struct":null,"x-validate":null}},"title":"CompanySpendResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Spend.Response","x-validate":null}},"components/schemas/ProductAttributesFilter":{"id":"components/schemas/ProductAttributesFilter","kind":"json-schema","title":"ProductAttributesFilter","data":{"allOf":[{"$ref":"#/components/schemas/AnyNoneNumericInclusionFilter"}],"description":"Filter by Product Attribute IDs","example":{"ids":[16994],"inclusion_method":"ANY_PRESENT"},"title":"ProductAttributesFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Install.Filters.ProductAttributesFilter","x-validate":null}},"components/schemas/ProductAttributesFilterCompanyInstalls":{"id":"components/schemas/ProductAttributesFilterCompanyInstalls","kind":"json-schema","title":"ProductAttributesFilterCompanyInstalls","data":{"allOf":[{"$ref":"#/components/schemas/AnyNumericInclusionFilter"}],"description":"Filter based on the product attributes associated with an install record.","example":{"ids":[222],"inclusion_method":"ANY_PRESENT"},"title":"ProductAttributesFilterCompanyInstalls","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.Installs.ProductAttributesFilter","x-validate":null}},"components/schemas/JsonErrorResponse":{"id":"components/schemas/JsonErrorResponse","kind":"json-schema","title":"JsonErrorResponse","data":{"properties":{"errors":{"items":{"properties":{"detail":{"example":"null value where string expected","type":"string","x-struct":null,"x-validate":null},"source":{"properties":{"pointer":{"example":"/data/attributes/petName","type":"string","x-struct":null,"x-validate":null}},"required":["pointer"],"type":"object","x-struct":null,"x-validate":null},"title":{"example":"Invalid value","type":"string","x-struct":null,"x-validate":null}},"required":["title","source","detail"],"type":"object","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"required":["errors"],"title":"JsonErrorResponse","type":"object","x-struct":"Elixir.OpenApiSpex.JsonErrorResponse","x-validate":null}},"components/schemas/AnyNoneInclusionMethod":{"id":"components/schemas/AnyNoneInclusionMethod","kind":"json-schema","title":"AnyNoneInclusionMethod","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inclusion method for just ANY_PRESENT or NONE_PRESENT"},"children":[]}]}]}],"enum":["ANY_PRESENT","NONE_PRESENT"],"title":"AnyNoneInclusionMethod","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.AnyNoneInclusionMethod","x-validate":null}},"components/schemas/SICUS1987":{"id":"components/schemas/SICUS1987","kind":"json-schema","title":"SICUS1987","data":{"description":"SIC US 1987 schema","example":{"code":"33636","codeStandard":"5912","id":"3FCEDF144BE9F3DFF1145DB6C515FB34","name":"Foo Bar","parentId":"264DD858DB942CAD06F24FF25DF56716"},"properties":{"code":{"description":"SIC US 1987 code","type":"string","x-struct":null,"x-validate":null},"codeStandard":{"description":"SIC US 1987 code standard","type":"string","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"SIC US 1987 name","type":"string","x-struct":null,"x-validate":null},"parentId":{"description":"Parent SIC US 1987 ID","type":"string","x-struct":null,"x-validate":null}},"required":["code","id","name","parentId","codeStandard"],"title":"SICUS1987","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.SicUS1987.SicUS1987Def","x-validate":null}},"components/schemas/CompanySpendsSelectFields":{"id":"components/schemas/CompanySpendsSelectFields","kind":"json-schema","title":"CompanySpendsSelectFields","data":{"default":["company_id","spend","category_id","country_code"],"description":"A list of data points to be returned in the API response.","items":{"$ref":"#/components/schemas/CompanySpendFieldNames"},"title":"CompanySpendsSelectFields","type":"array","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Spend.SelectFields","x-validate":null}},"components/schemas/AnyNoneIdInclusionFilter":{"id":"components/schemas/AnyNoneIdInclusionFilter","kind":"json-schema","title":"AnyNoneIdInclusionFilter","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inclusion filter object for use with hex encoded IDs. Can filter ids by ANY_PRESENT or NONE_PRESENT inclusion methods"},"children":[]}]}]}],"example":{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"ANY_PRESENT"},"properties":{"ids":{"description":"Hex Encoded IDs","items":{"$ref":"#/components/schemas/Id"},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"inclusion_method":{"$ref":"#/components/schemas/AnyNoneInclusionMethod"}},"required":["ids","inclusion_method"],"title":"AnyNoneIdInclusionFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.AnyNoneIdInclusionFilter","x-validate":null}},"components/schemas/AnyAllInclusionMethod":{"id":"components/schemas/AnyAllInclusionMethod","kind":"json-schema","title":"AnyAllInclusionMethod","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inclusion method for just ANY_PRESENT or ALL_PRESENT"},"children":[]}]}]}],"enum":["ANY_PRESENT","ALL_PRESENT"],"title":"AnyAllInclusionMethod","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.AnyAllInclusionMethod","x-validate":null}},"components/schemas/IntentContextTypes":{"id":"components/schemas/IntentContextTypes","kind":"json-schema","title":"IntentContextTypes","data":{"description":"Intent Context Types schema","example":{"description":"Foo bar description","id":"2E64D9D97CF79E96941A831E40507CA2","name":"Displacement"},"properties":{"description":{"description":"Intent Context Type description","type":"string","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"Intent Context Type name","type":"string","x-struct":null,"x-validate":null}},"required":["id","name","description"],"title":"IntentContextTypes","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.IntentContextTypes.IntentContextTypesDef","x-validate":null}},"components/schemas/UnauthorizedResponse":{"id":"components/schemas/UnauthorizedResponse","kind":"json-schema","title":"UnauthorizedResponse","data":{"properties":{"errors":{"items":{"properties":{"detail":{"example":"The token provided is not valid","type":"string","x-struct":null,"x-validate":null},"source":{"nullable":true,"type":"string","x-struct":null,"x-validate":null},"title":{"example":"Unauthorized","type":"string","x-struct":null,"x-validate":null}},"required":["title","detail"],"type":"object","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"title":"UnauthorizedResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.Common.Error.UnauthorizedResponse","x-validate":null}},"components/schemas/CompanySpendSorts":{"id":"components/schemas/CompanySpendSorts","kind":"json-schema","title":"CompanySpendSorts","data":{"items":{"$ref":"#/components/schemas/CompanySpendSortedSpendField"},"title":"CompanySpendSorts","type":"array","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Spend.Sorts","x-validate":null}},"components/schemas/Industry":{"id":"components/schemas/Industry","kind":"json-schema","title":"Industry","data":{"description":"Industry schema","example":{"id":"63E88D6A88D45AB23B4CB4E71CB5A2E","name":"Foo Bar"},"properties":{"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"Industry name","type":"string","x-struct":null,"x-validate":null}},"required":["id","name"],"title":"Industry","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.Industries.Industry","x-validate":null}},"components/schemas/Vendor":{"id":"components/schemas/Vendor","kind":"json-schema","title":"Vendor","data":{"description":"Vendor schema","example":{"id":"10056","name":"Vendor Name","url":"https://vendor.com"},"properties":{"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"Vendor name","type":"string","x-struct":null,"x-validate":null},"url":{"description":"Vendor URL","type":"string","x-struct":null,"x-validate":null}},"required":["id","name","url"],"title":"Vendor","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.Vendors.Vendor","x-validate":null}},"components/schemas/CompanyIdentifierFilters":{"id":"components/schemas/CompanyIdentifierFilters","kind":"json-schema","title":"CompanyIdentifierFilters","data":{"description":"Filters based around company identifiers.","example":{"company_ids":{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"ANY_PRESENT"}},"properties":{"company_ids":{"allOf":[{"$ref":"#/components/schemas/AnyIdInclusionFilter"}],"description":"A list of hex encoded company identifiers to filter your results by.\nAny company that matches one of the provided identifiers will be returned.\n","example":{"ids":["1C4B141E475CD272E44F67087E0FDFD4"],"inclusion_method":"ANY_PRESENT"},"type":"object","x-struct":null,"x-validate":null},"company_ids_including_corporate_relatives":{"allOf":[{"$ref":"#/components/schemas/AnyIdInclusionFilter"}],"description":"A list of hex encoded company identifiers to filter your results by.\nResults will include both the companies which match the provided IDs, as well as all other companies within it's corporate hierarchy.\n","example":{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"ANY_PRESENT"},"type":"object","x-struct":null,"x-validate":null}},"title":"CompanyIdentifierFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.CompanyIdentifiers","x-validate":null}},"components/schemas/CompanyFaiFilters":{"id":"components/schemas/CompanyFaiFilters","kind":"json-schema","title":"CompanyFaiFilters","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters to be used to narrow down the functional area intelligence data to return. Must provide either company_id OR company_ids, but not both."},"children":[]}]}]}],"example":{"company_id":"0252985AFE13886BC6FFA5CEBD75F4FA","departments":["0D32106BCB6DE321930CF34574EA388C","3D4C638DA5F85D025963F99FE90B1B1A","2C329EF27D7F8CB49D656D5502B9E939"],"products":[1150,805,25421,826,814,562],"roles":["2AB3F09BBBA80FF82B8FD5916954C46A","2E6BAB5FC1C661EDD7A863D4DCA3415B","21C896AFCD34E446180844D91359246E","39FD56FC1455D4D872DB14F656225740"]},"properties":{"company_id":{"$ref":"#/components/schemas/Id"},"company_ids":{"description":"Array of company IDs","items":{"$ref":"#/components/schemas/Id"},"maxItems":1000,"minItems":1,"type":"array","x-struct":null,"x-validate":null},"departments":{"description":"Return functional area intelligence records which are based on the provided department ids.","items":{"$ref":"#/components/schemas/Id"},"minItems":1,"nullable":false,"type":"array","x-struct":null,"x-validate":null},"products":{"description":"Return functional area intelligence records which are based on the provided product ids.","items":{"type":"integer","x-struct":null,"x-validate":null},"minItems":1,"nullable":false,"type":"array","x-struct":null,"x-validate":null},"roles":{"description":"Return functional area intelligence records which are based on the provided department role ids.","items":{"$ref":"#/components/schemas/Id"},"minItems":1,"nullable":false,"type":"array","x-struct":null,"x-validate":null}},"required":["products","departments"],"title":"CompanyFaiFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Fai.Filters","x-validate":null}},"components/schemas/AnyNumericInclusionFilter":{"id":"components/schemas/AnyNumericInclusionFilter","kind":"json-schema","title":"AnyNumericInclusionFilter","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inclusion filter object using integer IDs. Can filter ids by the ANY_PRESENT inclusion method."},"children":[]}]}]}],"example":{"ids":[16994],"inclusion_method":"ANY_PRESENT"},"properties":{"ids":{"description":"Numeric IDs","items":{"type":"integer","x-struct":null,"x-validate":null},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"inclusion_method":{"$ref":"#/components/schemas/AnyInclusionMethod"}},"required":["ids","inclusion_method"],"title":"AnyNumericInclusionFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.AnyNumericInclusionFilter","x-validate":null}},"components/schemas/CompanySearchFieldNames":{"id":"components/schemas/CompanySearchFieldNames","kind":"json-schema","title":"CompanySearchFieldNames","data":{"description":"Allowed fields to be selected and returned in the response.","enum":["company_id","company_name","domain_name","domain_name_normalized"],"title":"CompanySearchFieldNames","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Search.SelectFields.FieldNames","x-validate":null}},"components/schemas/CompanyIntentSortedIntentField":{"id":"components/schemas/CompanyIntentSortedIntentField","kind":"json-schema","title":"CompanyIntentSortedIntentField","data":{"properties":{"direction":{"$ref":"#/components/schemas/SortDirection"},"field":{"$ref":"#/components/schemas/CompanyIntentSortFields"}},"required":["field","direction"],"title":"CompanyIntentSortedIntentField","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Intent.Sorts.Sort","x-validate":null}},"components/schemas/MinFilter":{"id":"components/schemas/MinFilter","kind":"json-schema","title":"MinFilter","data":{"description":"Minimum range filter object","example":{"min":25},"maxProperties":1,"properties":{"min":{"description":"Minimum value","minimum":0,"type":"integer","x-struct":null,"x-validate":null}},"required":["min"],"title":"MinFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.MinFilter","x-validate":null}},"components/schemas/CompanyIntentFieldNames":{"id":"components/schemas/CompanyIntentFieldNames","kind":"json-schema","title":"CompanyIntentFieldNames","data":{"description":"Allowed fields to be selected and returned in the response.","enum":["topic_id","topic_name","url","signal_strength","signal_trend","location_strength","buyers_journey_name","context_name_array","state_name","country_name","region_name","datestamp"],"title":"CompanyIntentFieldNames","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Intent.SelectFields.FieldNames","x-validate":null}},"components/schemas/CompanySpendFilters":{"id":"components/schemas/CompanySpendFilters","kind":"json-schema","title":"CompanySpendFilters","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters for company spend data. Must provide either company_id OR company_ids, but not both."},"children":[]}]}]}],"example":{"category_ids":["03B36D42E7F8E60BE58BA4356B6AF40C","3B7D551F81A8A448041BF23C85E3D21B"],"company_id":"1698C53EBC888758570396E0334965C1"},"properties":{"category_ids":{"description":"Array of category IDs to filter by","items":{"$ref":"#/components/schemas/Id"},"type":"array","x-struct":null,"x-validate":null},"company_id":{"$ref":"#/components/schemas/Id"},"company_ids":{"description":"Array of company IDs","items":{"$ref":"#/components/schemas/Id"},"maxItems":1000,"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"title":"CompanySpendFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Spend.Filters","x-validate":null}},"components/schemas/InstallObjectIdentifiers":{"id":"components/schemas/InstallObjectIdentifiers","kind":"json-schema","title":"InstallObjectIdentifiers","data":{"description":"A smaller object to identify a Company, no firmographic information.","properties":{"product_id":{"type":"integer","x-struct":null,"x-validate":null},"product_name":{"type":"string","x-struct":null,"x-validate":null}},"title":"InstallObjectIdentifiers","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Install.Object.Identifiers","x-validate":null}},"components/schemas/CountriesResponse":{"id":"components/schemas/CountriesResponse","kind":"json-schema","title":"CountriesResponse","data":{"description":"Response schema for countries","example":{"count":1,"data":[{"alpha2":"FR","id":"6FA567B72D78B7E3EA746973FBBD1D5","name":"France","region":{"id":"22F89A300F983190022374848C4353B0","name":"EMEA"}}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/Country"},"type":"array","x-struct":null,"x-validate":null}},"title":"CountriesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.Countries.Response","x-validate":null}},"components/schemas/SpendObject":{"id":"components/schemas/SpendObject","kind":"json-schema","title":"SpendObject","data":{"properties":{"category_description":{"type":"string","x-struct":null,"x-validate":null},"category_id":{"type":"string","x-struct":null,"x-validate":null},"category_name":{"type":"string","x-struct":null,"x-validate":null},"company_id":{"type":"string","x-struct":null,"x-validate":null},"country_code":{"type":"string","x-struct":null,"x-validate":null},"country_name":{"type":"string","x-struct":null,"x-validate":null},"spend":{"type":"integer","x-struct":null,"x-validate":null}},"title":"SpendObject","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Spend.Object","x-validate":null}},"components/schemas/IntentTopicsFilter":{"id":"components/schemas/IntentTopicsFilter","kind":"json-schema","title":"IntentTopicsFilter","data":{"allOf":[{"$ref":"#/components/schemas/AnyAllIdInclusionFilter"}],"description":"Filter based on the topics associated with an intent signal.","example":{"ids":["19861D3AC60455102792F87A33AF533F"],"inclusion_method":"ANY_PRESENT"},"title":"IntentTopicsFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.Intent.IntentTopicsFilter","x-validate":null}},"components/schemas/CompanyIntentFilters":{"id":"components/schemas/CompanyIntentFilters","kind":"json-schema","title":"CompanyIntentFilters","data":{"example":{"company_id":"1698C53EBC888758570396E0334965C1","topic_ids":["243E8A9405E4B25CBCDB2D0DC14ED608","243F7993B10E4519E189D18FCF58388C","24435A2522405B507389E2CB4784C4DD"]},"properties":{"company_id":{"$ref":"#/components/schemas/Id"},"topic_ids":{"items":{"$ref":"#/components/schemas/Id"},"nullable":true,"type":"array","x-struct":null,"x-validate":null}},"required":["company_id"],"title":"CompanyIntentFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Intent.Filters","x-validate":null}},"components/schemas/ProductsResponse":{"id":"components/schemas/ProductsResponse","kind":"json-schema","title":"ProductsResponse","data":{"description":"Response schema for products","example":{"count":1,"data":[{"category":{"id":"63E88D6A88D45AB23B4CB4E71CB5A2E"},"description":"Foo bar is an amazing product!","id":32,"name":"Foo Bar","vendor":{"id":493}}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/Product"},"type":"array","x-struct":null,"x-validate":null}},"title":"ProductsResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.Products.Response","x-validate":null}},"components/schemas/CountryCodeFilter":{"id":"components/schemas/CountryCodeFilter","kind":"json-schema","title":"CountryCodeFilter","data":{"description":"Inclusion filter object (using string names as IDs)","example":{"ids":["CA","US"],"inclusion_method":"ANY_PRESENT"},"properties":{"ids":{"description":"Country Codes","items":{"maxLength":2,"minLength":2,"type":"string","x-struct":null,"x-validate":null},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"inclusion_method":{"$ref":"#/components/schemas/AnyNoneInclusionMethod"}},"required":["ids","inclusion_method"],"title":"CountryCodeFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.CountryCodeFilter","x-validate":null}},"components/schemas/SpendCategories":{"id":"components/schemas/SpendCategories","kind":"json-schema","title":"SpendCategories","data":{"description":"Spend categories schema","example":{"exportName":"export_foo_bar","id":"5D8B4B61BA2C56471268612D83903B6","name":"Application Led Outsourcing","nameTree":["Total IT","Total External IT","Services","Application Led Outsourcing"],"parentId":"1DF1C16E82351BD6ABC74D230191CD1E"},"properties":{"exportName":{"description":"Spend category export name","type":"string","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"Spend category name","type":"string","x-struct":null,"x-validate":null},"nameTree":{"description":"Spend category name tree","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"parentId":{"description":"Spend category parent ID","type":"string","x-struct":null,"x-validate":null}},"required":["id","name","exportName","nameTree","parentId"],"title":"SpendCategories","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.SpendCategories.SpendCategory","x-validate":null}},"components/schemas/CompanyIntentSorts":{"id":"components/schemas/CompanyIntentSorts","kind":"json-schema","title":"CompanyIntentSorts","data":{"items":{"$ref":"#/components/schemas/CompanyIntentSortedIntentField"},"title":"CompanyIntentSorts","type":"array","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Intent.Sorts","x-validate":null}},"components/schemas/Country":{"id":"components/schemas/Country","kind":"json-schema","title":"Country","data":{"description":"Country schema","example":{"alpha2":"FR","id":"6FA567B72D78B7E3EA746973FBBD1D5","name":"France","region":{"id":"22F89A300F983190022374848C4353B0","name":"EMEA"}},"properties":{"alpha2":{"description":"Country code (alpha-2)","type":"string","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"Country name","type":"string","x-struct":null,"x-validate":null},"region":{"properties":{"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"Region name","type":"string","x-struct":null,"x-validate":null}},"required":["id","name"],"type":"object","x-struct":null,"x-validate":null}},"required":["alpha2","id","name","region"],"title":"Country","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.Countries.Country","x-validate":null}},"components/schemas/ProductFilter":{"id":"components/schemas/ProductFilter","kind":"json-schema","title":"ProductFilter","data":{"allOf":[{"$ref":"#/components/schemas/AnyNoneNumericInclusionFilter"}],"description":"Filter by Product IDs","example":{"ids":[16994],"inclusion_method":"ANY_PRESENT"},"title":"ProductFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Install.Filters.ProductFilter","x-validate":null}},"components/schemas/CompanyInfoResponse":{"id":"components/schemas/CompanyInfoResponse","kind":"json-schema","title":"CompanyInfoResponse","data":{"allOf":[{"$ref":"#/components/schemas/CompanyObjectIdentifiers"},{"$ref":"#/components/schemas/CompanyObject"}],"description":"Firmographic data about the company.","title":"CompanyInfoResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Info.Response","x-validate":null}},"components/schemas/NotFoundResponse":{"id":"components/schemas/NotFoundResponse","kind":"json-schema","title":"NotFoundResponse","data":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"null","x-struct":null,"x-validate":null},"source":{"type":"null","x-struct":null,"x-validate":null},"title":{"example":"Not Found","type":"string","x-struct":null,"x-validate":null}},"required":["title","detail"],"type":"object","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"title":"NotFoundResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.Common.Error.NotFoundResponse","x-validate":null}},"components/schemas/CompanyCorporateHierarchyFilters":{"id":"components/schemas/CompanyCorporateHierarchyFilters","kind":"json-schema","title":"CompanyCorporateHierarchyFilters","data":{"description":"Filters based on a company's corporate hierarchy classification.","example":{"is_domestic_parent":true,"is_global_headquarters":true},"properties":{"is_corporate_parent":{"description":"Filter based on if a company is classified as a corporate parent or not.","type":"boolean","x-struct":null,"x-validate":null},"is_domestic_parent":{"description":"Filter based on if a company is classified as a domestic parent or not.","type":"boolean","x-struct":null,"x-validate":null},"is_global_headquarters":{"description":"Filter based on if a company is classified as a global headquarters or not.","type":"boolean","x-struct":null,"x-validate":null}},"title":"CompanyCorporateHierarchyFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.CorporateHierarchy","x-validate":null}},"components/schemas/AnyAllIdInclusionFilter":{"id":"components/schemas/AnyAllIdInclusionFilter","kind":"json-schema","title":"AnyAllIdInclusionFilter","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inclusion filter object for use with hex encoded IDs. Can filter ids by ANY_PRESENT or ALL_PRESENT inclusion methods"},"children":[]}]}]}],"example":{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"ANY_PRESENT"},"properties":{"ids":{"description":"Hex Encoded IDs","items":{"$ref":"#/components/schemas/Id"},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"inclusion_method":{"$ref":"#/components/schemas/AnyAllInclusionMethod"}},"required":["ids","inclusion_method"],"title":"AnyAllIdInclusionFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.AnyAllIdInclusionFilter","x-validate":null}},"components/schemas/IntentContextTypesResponse":{"id":"components/schemas/IntentContextTypesResponse","kind":"json-schema","title":"IntentContextTypesResponse","data":{"description":"Response schema for Intent Context Types","example":{"count":1,"data":[{"description":"Foo bar description","id":"2E64D9D97CF79E96941A831E40507CA2","name":"Displacement"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/IntentContextTypes"},"type":"array","x-struct":null,"x-validate":null}},"title":"IntentContextTypesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.IntentContextTypes.Response","x-validate":null}},"components/schemas/EmployeesFilter":{"id":"components/schemas/EmployeesFilter","kind":"json-schema","title":"EmployeesFilter","data":{"description":"Filter by the number of employees working at a company. Some companies are listed as having a single discrete number of employees, while others are listed as a range. By default this filter will match against both.","example":{"has_fixed_employees":true,"max":2500,"min":500},"properties":{"has_fixed_employees":{"description":"Whether to limit the companies returned to those with a fixed number of employees (and exclude those listed as a range).","nullable":true,"type":"boolean","x-struct":null,"x-validate":null},"max":{"description":"The maximum number of employees to match against.","minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"min":{"description":"The minimum number of employees to match against.","minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null}},"title":"EmployeesFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.Firmographics.EmployeesFilter","x-validate":null}},"components/schemas/SpendCategoriesResponse":{"id":"components/schemas/SpendCategoriesResponse","kind":"json-schema","title":"SpendCategoriesResponse","data":{"description":"Response schema for Spend categories","example":{"count":1,"data":[{"exportName":"export_foo_bar","id":"5D8B4B61BA2C56471268612D83903B6","name":"Application Led Outsourcing","nameTree":["Total IT","Total External IT","Services","Application Led Outsourcing"],"parentId":"1DF1C16E82351BD6ABC74D230191CD1E"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/SpendCategories"},"type":"array","x-struct":null,"x-validate":null}},"title":"SpendCategoriesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.SpendCategories.Response","x-validate":null}},"components/schemas/CompanyFaiSelectFields":{"id":"components/schemas/CompanyFaiSelectFields","kind":"json-schema","title":"CompanyFaiSelectFields","data":{"default":["company_id","product_name","department_name","role_name"],"description":"List of fields to be selected.","example":["company_id","product_name","department_name","role_name"],"items":{"$ref":"#/components/schemas/CompanyFaiFieldNames"},"nullable":true,"title":"CompanyFaiSelectFields","type":"array","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Fai.SelectFields","x-validate":null}},"components/schemas/MaxFilter":{"id":"components/schemas/MaxFilter","kind":"json-schema","title":"MaxFilter","data":{"description":"Maximum range filter object","example":{"max":50},"maxProperties":1,"properties":{"max":{"description":"Maximum value","minimum":0,"type":"integer","x-struct":null,"x-validate":null}},"required":["max"],"title":"MaxFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.MaxFilter","x-validate":null}},"components/schemas/CompanyFieldNames":{"id":"components/schemas/CompanyFieldNames","kind":"json-schema","title":"CompanyFieldNames","data":{"description":"Allowed fields to be selected and returned in the response. Includes deprecated OppGen fields for backwards compatibility.","enum":["company_id","company_name","domain_name","domain_name_normalized","company_level","city_name","state_name","postal_code","country_name","country_code","continent_name","subcontinent_name","geopolitical_name","industry_id","industry_name","naics_code","naics_name","sic_codes","sic_names","revenue_total","revenue_band","employees_total","employees_band","it_spend","forbes_2000_rank","fortune_500_rank","global_hq_company_name","global_hq_domain_name","global_hq_domain_name_normalized","global_hq_hg_id","global_hq_city_name","global_hq_state_name","global_hq_postal_code","global_hq_country_name","global_hq_country_code","global_hq_subcontinent_name","global_hq_continent_name","global_hq_geopolitical_name","global_hq_employees_band","global_hq_revenue_band","global_hq_industry_id","global_hq_industry_name","global_hq_naics_code","global_hq_naics_name","global_hq_sic_codes","global_hq_sic_names","global_hq_forbes_2000_rank","global_hq_fortune_500_rank"],"title":"CompanyFieldNames","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.SelectFields.FieldNames","x-validate":null}},"components/schemas/CompanyFaiRequest":{"id":"components/schemas/CompanyFaiRequest","kind":"json-schema","title":"CompanyFaiRequest","data":{"description":"Retrieve functional area intelligence data for a company based on certain criteria.","properties":{"fields":{"$ref":"#/components/schemas/CompanyFaiSelectFields"},"filters":{"$ref":"#/components/schemas/CompanyFaiFilters"}},"required":["filters"],"title":"CompanyFaiRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Fai.Request","x-validate":null}},"components/schemas/CountryCodesFilter":{"id":"components/schemas/CountryCodesFilter","kind":"json-schema","title":"CountryCodesFilter","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the country in which a company is based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepts a list of alpha-2 codes along with an inclusion method, with the inclusion method specifying whether companies should be included or excluded from the results based on the provided country codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alpha-2 codes are based on the ISO 3166 international standard. A complete list can be found here: https://www.iso.org/obp/ui/#search\","},"children":[]}]}]}],"example":[{"ids":["CA","US"],"inclusion_method":"ANY_PRESENT"},{"ids":["GB"],"inclusion_method":"NONE_PRESENT"}],"items":{"$ref":"#/components/schemas/CountryCodeFilter"},"minItems":1,"title":"CountryCodesFilter","type":"array","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.CountryCodesFilter","x-validate":null}},"components/schemas/CompanySearchRequest":{"id":"components/schemas/CompanySearchRequest","kind":"json-schema","title":"CompanySearchRequest","data":{"description":"A search query to get a list of companies based on filter criteria.","example":{"fields":["company_id","company_name","domain_name","domain_name_normalized"],"filters":{"company_identifiers":{"company_ids":{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"ANY_PRESENT"}},"corporate_hierarchy":{"is_domestic_parent":true,"is_global_headquarters":true},"firmographics":{"country_codes":[{"ids":["US"],"inclusion_method":"ANY_PRESENT"}],"employees":{"max":2500000,"min":1500000},"industries":[{"ids":[16],"inclusion_method":"ANY_PRESENT"}],"region_names":{"ids":["AMER"],"inclusion_method":"ANY_PRESENT"},"revenue":{"max":700000000000,"min":600000000000}},"installs":{"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"}]},"intent":{"signal_score":"MEDIUM","topics":{"ids":["19861D3AC60455102792F87A33AF533F"],"inclusion_method":"ANY_PRESENT"}},"spend":[{"categories":{"ids":["3B36D42E7F8E60BE58BA4356B6AF40C"],"inclusion_method":"ANY_PRESENT"},"range":{"min":2000000000}}]},"limit":10,"offset":0,"sorts":[{"direction":"DESC","field":"company_name"}]},"properties":{"fields":{"$ref":"#/components/schemas/SelectedCompanySearchFields"},"filters":{"$ref":"#/components/schemas/CompanyFilters"},"limit":{"$ref":"#/components/schemas/Limit"},"offset":{"$ref":"#/components/schemas/Offset"},"sorts":{"$ref":"#/components/schemas/CompanyFieldSorts"}},"required":["filters","fields"],"title":"CompanySearchRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Search.Request","x-validate":null}},"components/schemas/CompanyInstallsResponse":{"id":"components/schemas/CompanyInstallsResponse","kind":"json-schema","title":"CompanyInstallsResponse","data":{"description":"A list of installs for a company, and number of total installs found.","properties":{"count":{"description":"The number of installs at the company fitting the criteria.","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/InstallObject"},"type":"array","x-struct":null,"x-validate":null}},"title":"CompanyInstallsResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Installs.Response","x-validate":null}},"components/schemas/CompanyFilters":{"id":"components/schemas/CompanyFilters","kind":"json-schema","title":"CompanyFilters","data":{"description":"Filters object","example":{"company_identifiers":{"company_ids":{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"ANY_PRESENT"}},"corporate_hierarchy":{"is_domestic_parent":true,"is_global_headquarters":true},"firmographics":{"country_codes":[{"ids":["US"],"inclusion_method":"ANY_PRESENT"}],"employees":{"max":2500000,"min":1500000},"industries":[{"ids":[16],"inclusion_method":"ANY_PRESENT"}],"region_names":{"ids":["AMER"],"inclusion_method":"ANY_PRESENT"},"revenue":{"max":700000000000,"min":600000000000}},"installs":{"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"}]},"intent":{"signal_score":"MEDIUM","topics":{"ids":["19861D3AC60455102792F87A33AF533F"],"inclusion_method":"ANY_PRESENT"}},"spend":[{"categories":{"ids":["3B36D42E7F8E60BE58BA4356B6AF40C"],"inclusion_method":"ANY_PRESENT"},"range":{"min":2000000000}}]},"properties":{"company_identifiers":{"$ref":"#/components/schemas/CompanyIdentifierFilters"},"corporate_hierarchy":{"$ref":"#/components/schemas/CompanyCorporateHierarchyFilters"},"firmographics":{"$ref":"#/components/schemas/CompanyFirmographicFilters"},"installs":{"$ref":"#/components/schemas/CompanyInstallFilters"},"intent":{"$ref":"#/components/schemas/CompanyFiltersIntent"},"spend":{"description":"Filter results based on spend filters","items":{"$ref":"#/components/schemas/SpendFilter"},"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"title":"CompanyFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters","x-validate":null}},"components/schemas/CompanyFirmographicFilters":{"id":"components/schemas/CompanyFirmographicFilters","kind":"json-schema","title":"CompanyFirmographicFilters","data":{"description":"Firmographic based filters for companies.","example":{"country_codes":[{"ids":["US"],"inclusion_method":"ANY_PRESENT"}],"employees":{"max":2500000,"min":1500000},"industries":[{"ids":[16],"inclusion_method":"ANY_PRESENT"}],"region_names":{"ids":["AMER"],"inclusion_method":"ANY_PRESENT"},"revenue":{"max":700000000000,"min":600000000000}},"properties":{"country_codes":{"$ref":"#/components/schemas/CountryCodesFilter"},"employees":{"$ref":"#/components/schemas/EmployeesFilter"},"industries":{"description":"Filter by the industry which a company is categorized by.\nAccepts a list of HG Insights derived identifiers along with an inclusion method, with the inclusion method specifying whether companies should be included or excluded from the results based on the provided industry ids.\n","example":[{"ids":[16],"inclusion_method":"NONE_PRESENT"}],"items":{"$ref":"#/components/schemas/AnyNoneNumericInclusionFilter"},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"region_names":{"$ref":"#/components/schemas/AnyNameInclusionFilter"},"revenue":{"$ref":"#/components/schemas/RevenueFilter"},"state_ids":{"$ref":"#/components/schemas/AnyIdInclusionFilter"}},"title":"CompanyFirmographicFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.Firmographics","x-validate":null}},"components/schemas/CompanyFaiData":{"id":"components/schemas/CompanyFaiData","kind":"json-schema","title":"CompanyFaiData","data":{"description":"Functional area intelligence data for a company","properties":{"company_id":{"$ref":"#/components/schemas/Id"},"decision_maker_presence":{"type":"boolean","x-struct":null,"x-validate":null},"department_id":{"$ref":"#/components/schemas/Id"},"department_name":{"type":"string","x-struct":null,"x-validate":null},"department_signal_strength":{"type":"integer","x-struct":null,"x-validate":null},"department_usage_share":{"type":"integer","x-struct":null,"x-validate":null},"influencer_presence":{"type":"boolean","x-struct":null,"x-validate":null},"last_verified_at":{"type":"string","x-struct":null,"x-validate":null},"product_id":{"type":"integer","x-struct":null,"x-validate":null},"product_name":{"type":"string","x-struct":null,"x-validate":null},"role_id":{"nullable":true,"type":"string","x-struct":null,"x-validate":null},"role_name":{"nullable":true,"type":"string","x-struct":null,"x-validate":null},"role_signal_share":{"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"role_usage_share":{"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"signal_city_name":{"type":"string","x-struct":null,"x-validate":null},"signal_country_name":{"type":"string","x-struct":null,"x-validate":null},"signal_state_name":{"type":"string","x-struct":null,"x-validate":null},"total_count":{"type":"integer","x-struct":null,"x-validate":null}},"title":"CompanyFaiData","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Fai.Data","x-validate":null}},"components/schemas/CompanyIntentObject":{"id":"components/schemas/CompanyIntentObject","kind":"json-schema","title":"CompanyIntentObject","data":{"properties":{"buyers_journey_name":{"type":"string","x-struct":null,"x-validate":null},"context_name_array":{"items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"country_name":{"type":"string","x-struct":null,"x-validate":null},"datestamp":{"type":"string","x-struct":null,"x-validate":null},"location_strength":{"type":"integer","x-struct":null,"x-validate":null},"region_name":{"type":"string","x-struct":null,"x-validate":null},"signal_strength":{"type":"integer","x-struct":null,"x-validate":null},"signal_trend":{"type":"number","x-struct":null,"x-validate":null},"state_name":{"type":"string","x-struct":null,"x-validate":null},"topic_id":{"type":"string","x-struct":null,"x-validate":null},"topic_name":{"type":"string","x-struct":null,"x-validate":null},"url":{"type":"string","x-struct":null,"x-validate":null}},"title":"CompanyIntentObject","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Intent.Object","x-validate":null}},"components/schemas/CompanyInfoListResponse":{"id":"components/schemas/CompanyInfoListResponse","kind":"json-schema","title":"CompanyInfoListResponse","data":{"description":"Firmographic data about the companies.","properties":{"count":{"description":"The number of companies returned.","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"allOf":[{"$ref":"#/components/schemas/CompanyObjectIdentifiers"},{"$ref":"#/components/schemas/CompanyObject"}],"type":"object","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"title":"CompanyInfoListResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.InfoList.Response","x-validate":null}},"components/schemas/CompanyInfoListRequest":{"id":"components/schemas/CompanyInfoListRequest","kind":"json-schema","title":"CompanyInfoListRequest","data":{"description":"Find companies based on the input, and return all firmographic information about them.","properties":{"company_ids":{"description":"Array of company IDs to retrieve","items":{"$ref":"#/components/schemas/Id"},"maxItems":1000,"minItems":1,"type":"array","x-struct":null,"x-validate":null},"fields":{"$ref":"#/components/schemas/CompanyDataFields"},"limit":{"$ref":"#/components/schemas/Limit"},"offset":{"$ref":"#/components/schemas/Offset"}},"required":["company_ids"],"title":"CompanyInfoListRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.InfoList.Request","x-validate":null}},"components/schemas/InstallsFilters":{"id":"components/schemas/InstallsFilters","kind":"json-schema","title":"InstallsFilters","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter Product Installs by various criteria. Must provide either company_id OR company_ids, but not both."},"children":[]}]}]}],"example":{"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}}},"properties":{"company_id":{"$ref":"#/components/schemas/Id"},"company_ids":{"description":"Array of company IDs","items":{"$ref":"#/components/schemas/Id"},"maxItems":1000,"minItems":1,"type":"array","x-struct":null,"x-validate":null},"country_codes":{"$ref":"#/components/schemas/CountryCodeFilter"},"product_attributes":{"$ref":"#/components/schemas/ProductAttributesFilter"},"product_categories":{"$ref":"#/components/schemas/ProductCategoriesFilter"},"products":{"$ref":"#/components/schemas/ProductFilter"},"vendors":{"$ref":"#/components/schemas/VendorFilter"}},"title":"InstallsFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Install.Filters","x-validate":null}},"components/schemas/CompanyIntentRequest":{"id":"components/schemas/CompanyIntentRequest","kind":"json-schema","title":"CompanyIntentRequest","data":{"description":"A search query to get a list of intent data for a company, the can be optionally filtered by topic ids.","properties":{"fields":{"$ref":"#/components/schemas/CompanyIntentsSelectFields"},"filters":{"$ref":"#/components/schemas/CompanyIntentFilters"},"limit":{"$ref":"#/components/schemas/Limit"},"offset":{"$ref":"#/components/schemas/Offset"},"sorts":{"$ref":"#/components/schemas/CompanyIntentSorts"}},"required":["filters"],"title":"CompanyIntentRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Intent.Request","x-validate":null}},"components/schemas/CompanyFaiResponse":{"id":"components/schemas/CompanyFaiResponse","kind":"json-schema","title":"CompanyFaiResponse","data":{"description":"Response object for a company's functional area intelligence","properties":{"count":{"type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/CompanyFaiData"},"type":"array","x-struct":null,"x-validate":null}},"title":"CompanyFaiResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Fai.Response","x-validate":null}},"components/schemas/IntentTopic":{"id":"components/schemas/IntentTopic","kind":"json-schema","title":"IntentTopic","data":{"description":"Intent Topic schema","example":{"category":"technology","id":"3C974F539EF4BC6A0504AAB13C506780","name":"SysFoo"},"properties":{"category":{"description":"Intent Topic category","type":"string","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"Intent Topic name","type":"string","x-struct":null,"x-validate":null}},"required":["id","name","displayName","category"],"title":"IntentTopic","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.IntentTopics.IntentTopic","x-validate":null}},"components/schemas/State":{"id":"components/schemas/State","kind":"json-schema","title":"State","data":{"description":"State schema","example":{"country":{"alpha2":"FR"},"id":"AEA8D2254D475DED13FD3F4339C6B8G","name":"Île-de-France"},"properties":{"country":{"properties":{"alpha2":{"description":"Country code (alpha-2)","type":"string","x-struct":null,"x-validate":null}},"required":["alpha2"],"type":"object","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"State name","type":"string","x-struct":null,"x-validate":null}},"required":["country","id","name"],"title":"State","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.States.State","x-validate":null}},"components/schemas/SelectedInstallFields":{"id":"components/schemas/SelectedInstallFields","kind":"json-schema","title":"SelectedInstallFields","data":{"default":["product_id","product_name","vendor_name","product_last_verified_date","product_intensity","country_code"],"description":"List of fields to be selected.","items":{"$ref":"#/components/schemas/InstallFieldNames"},"nullable":true,"title":"SelectedInstallFields","type":"array","x-struct":"Elixir.TalariaWeb.Schemas.V1.Install.SelectFields","x-validate":null}},"components/schemas/SortedCompanyField":{"id":"components/schemas/SortedCompanyField","kind":"json-schema","title":"SortedCompanyField","data":{"description":"Sort object","example":{"direction":"DESC","field":"revenue_range_min"},"properties":{"direction":{"$ref":"#/components/schemas/SortDirection"},"field":{"$ref":"#/components/schemas/CompanySearchFieldNames"}},"required":["field","direction"],"title":"SortedCompanyField","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Search.Sorts.Sort","x-validate":null}},"components/schemas/SortDirection":{"id":"components/schemas/SortDirection","kind":"json-schema","title":"SortDirection","data":{"default":"ASC","description":"Sort direction","enum":["ASC","DESC"],"title":"SortDirection","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.SortDirection","x-validate":null}},"components/schemas/CompanyInstallFilters":{"id":"components/schemas/CompanyInstallFilters","kind":"json-schema","title":"CompanyInstallFilters","data":{"description":"Filters based around the install records detected at a company.","example":{"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"}]},"properties":{"product_attributes":{"$ref":"#/components/schemas/ProductAttributesFilterCompanyInstalls"},"product_categories":{"$ref":"#/components/schemas/ProductCategoriesFilter"},"products":{"description":"Filter based on the associated products for an install record. Can provide a list of product filters so different inclusion methods may be combined.","items":{"$ref":"#/components/schemas/ProductFilter"},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"vendors":{"description":"Filter based on the associated vendor for an install record. Can provide a list of vendor filters so different inclusion methods may be combined.","items":{"$ref":"#/components/schemas/VendorFilter"},"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"title":"CompanyInstallFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.Installs","x-validate":null}},"components/schemas/AnyNameInclusionFilter":{"id":"components/schemas/AnyNameInclusionFilter","kind":"json-schema","title":"AnyNameInclusionFilter","data":{"description":"Inclusion filter object (using string names as IDs)","example":{"ids":["CA","APAC"],"inclusion_method":"ANY_PRESENT"},"properties":{"ids":{"description":"Name IDs","items":{"type":"string","x-struct":null,"x-validate":null},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"inclusion_method":{"$ref":"#/components/schemas/AnyInclusionMethod"}},"required":["ids","inclusion_method"],"title":"AnyNameInclusionFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.AnyNameInclusionFilter","x-validate":null}},"components/schemas/CompanyIntentSortFields":{"id":"components/schemas/CompanyIntentSortFields","kind":"json-schema","title":"CompanyIntentSortFields","data":{"enum":["topic_id","signal_strength","datestamp"],"title":"CompanyIntentSortFields","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Intent.Sorts.SortFields","x-validate":null}},"components/schemas/CompanyDataFields":{"id":"components/schemas/CompanyDataFields","kind":"json-schema","title":"CompanyDataFields","data":{"default":["company_id","company_name","domain_name","domain_name_normalized"],"description":"A list of data points to be returned in the API response.","example":["company_id","company_name","domain_name","domain_name_normalized","company_level","city_name","state_name","postal_code","country_name","country_code","continent_name","subcontinent_name","geopolitical_name","industry_id","industry_name","naics_code","naics_name","sic_codes","sic_names","revenue_total","revenue_band","employees_total","employees_band","it_spend","forbes_2000_rank","fortune_500_rank","global_hq_company_name","global_hq_domain_name","global_hq_domain_name_normalized","global_hq_hg_id","global_hq_city_name","global_hq_state_name","global_hq_postal_code","global_hq_country_name","global_hq_country_code","global_hq_subcontinent_name","global_hq_continent_name","global_hq_geopolitical_name","global_hq_employees_band","global_hq_revenue_band","global_hq_industry_id","global_hq_industry_name","global_hq_naics_code","global_hq_naics_name","global_hq_sic_codes","global_hq_sic_names","global_hq_forbes_2000_rank","global_hq_fortune_500_rank"],"items":{"$ref":"#/components/schemas/CompanyFieldNames"},"title":"CompanyDataFields","type":"array","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.SelectFields","x-validate":null}},"components/schemas/ProductAttributesResponse":{"id":"components/schemas/ProductAttributesResponse","kind":"json-schema","title":"ProductAttributesResponse","data":{"description":"Response schema for product attributes","example":{"count":1,"data":[{"childrenAttributes":[{"description":"Cloud Application Performance Management (or Cloud APM) software allows businesses to manage and monitor resources that provide support for cloud-based applications. Cloud APM software helps administrators identify, address, and resolve issues that impact both back-end functions (such as costs, security, resource availability, traffic, latency, or application errors) and end-user experiences. The goal of Cloud APM is to improve application responsiveness, uptime, and UX.","id":2,"level":2,"name":"Cloud Application Performance Management"}],"description":"Cloud Computing refers to the delivery of computing services (hardware and software) via public, private, or hybrid cloud environments. Cloud Computing software includes but is not limited to servers, software, storage, networking, analytics, cloud APM, cloud CPG, cost optimization, workload management, data security, IT operations, and development environments.","id":1,"level":1,"name":"Cloud Computing"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/Product"},"type":"array","x-struct":null,"x-validate":null}},"title":"ProductAttributesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.ProductAttributes.Response","x-validate":null}},"components/schemas/SortedInstallField":{"id":"components/schemas/SortedInstallField","kind":"json-schema","title":"SortedInstallField","data":{"example":{"direction":"DESC","field":"product_id"},"properties":{"direction":{"$ref":"#/components/schemas/SortDirection"},"field":{"$ref":"#/components/schemas/SortableInstallFields"}},"required":["field","direction"],"title":"SortedInstallField","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Install.Sorts.InstallSort","x-validate":null}},"components/schemas/IntentBuyerJourney":{"id":"components/schemas/IntentBuyerJourney","kind":"json-schema","title":"IntentBuyerJourney","data":{"description":"Intent Buyer Journey schema","example":{"description":"Foo bar description","id":"2E64D9D97CF79E96941A831E40507CA2","name":"Evaluating"},"properties":{"description":{"description":"Intent Buyer Journey description","enum":["Researching","Evaluating"],"type":"string","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"Intent Buyer Journey name","type":"string","x-struct":null,"x-validate":null}},"required":["id","name","description"],"title":"IntentBuyerJourney","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.IntentBuyersJourney.IntentBuyersJourneyDef","x-validate":null}},"components/schemas/FindCompaniesResponse":{"id":"components/schemas/FindCompaniesResponse","kind":"json-schema","title":"FindCompaniesResponse","data":{"description":"Response schema for find companies","example":{"count":1,"data":[{"company_id":"6FA567B72D78B7E3EA746973FBBD1D5","company_name":"Adidas North America, Inc.","domain_name":"https://www.adidas.com"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/Company"},"type":"array","x-struct":null,"x-validate":null}},"title":"FindCompaniesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Companies.FindCompany.Response","x-validate":null}},"components/schemas/NAICS2012":{"id":"components/schemas/NAICS2012","kind":"json-schema","title":"NAICS2012","data":{"description":"NAICS 2012 schema","example":{"code":"33636","id":"3FCEDF144BE9F3DFF1145DB6C515FB34","name":"Foo Bar","parentId":"264DD858DB942CAD06F24FF25DF56716"},"properties":{"code":{"description":"NAICS code","type":"string","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"NAICS name","type":"string","x-struct":null,"x-validate":null},"parentId":{"$ref":"#/components/schemas/Id"}},"required":["code","id","name","parentId"],"title":"NAICS2012","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.Naics2012.Naics2012Def","x-validate":null}},"components/schemas/CompanyFaiFieldNames":{"id":"components/schemas/CompanyFaiFieldNames","kind":"json-schema","title":"CompanyFaiFieldNames","data":{"description":"Allowed fields to be selected and returned in the response.","enum":["company_id","product_id","product_name","department_id","department_name","department_usage_share","department_signal_strength","role_id","role_name","role_signal_strength_at_location","role_usage_share","signal_country_name","signal_state_name","signal_city_name","last_verified_at","is_decision_maker","is_influencer"],"title":"CompanyFaiFieldNames","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Fai.SelectFields.FieldNames","x-validate":null}},"components/schemas/AnyIdInclusionFilter":{"id":"components/schemas/AnyIdInclusionFilter","kind":"json-schema","title":"AnyIdInclusionFilter","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inclusion filter object for use with hex encoded IDs. Can filter ids by ANY_PRESENT inclusion method"},"children":[]}]}]}],"example":{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"ANY_PRESENT"},"properties":{"ids":{"description":"Hex Encoded IDs","items":{"$ref":"#/components/schemas/Id"},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"inclusion_method":{"$ref":"#/components/schemas/AnyInclusionMethod"}},"required":["ids","inclusion_method"],"title":"AnyIdInclusionFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.AnyIdInclusionFilter","x-validate":null}},"components/schemas/CompanyFiltersIntent":{"id":"components/schemas/CompanyFiltersIntent","kind":"json-schema","title":"CompanyFiltersIntent","data":{"description":"Filters based around intent signals.\nIntent signals are signals that indicate a company is showing interest in a particular topic.\n","example":{"signal_score":"MEDIUM","topics":{"ids":["19861D3AC60455102792F87A33AF533F"],"inclusion_method":"ANY_PRESENT"}},"properties":{"signal_score":{"$ref":"#/components/schemas/IntentSignalScoreFilter"},"topics":{"$ref":"#/components/schemas/IntentTopicsFilter"}},"required":["topics","signal_score"],"title":"CompanyFiltersIntent","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.Intent","x-validate":null}},"components/schemas/CompanySearchResponse":{"id":"components/schemas/CompanySearchResponse","kind":"json-schema","title":"CompanySearchResponse","data":{"description":"A list of companies and their identification information.","properties":{"count":{"description":"The total number of companies that match the search criteria.","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/CompanyObjectIdentifiers"},"type":"array","x-struct":null,"x-validate":null}},"title":"CompanySearchResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Search.Response","x-validate":null}},"components/schemas/CompanySpendRequest":{"id":"components/schemas/CompanySpendRequest","kind":"json-schema","title":"CompanySpendRequest","data":{"description":"A search query to get a list of spend data for a company, the can be optionally filtered by category ids.","properties":{"fields":{"$ref":"#/components/schemas/CompanySpendsSelectFields"},"filters":{"$ref":"#/components/schemas/CompanySpendFilters"},"limit":{"$ref":"#/components/schemas/Limit"},"offset":{"$ref":"#/components/schemas/Offset"},"sorts":{"$ref":"#/components/schemas/CompanySpendSorts"}},"required":["filters"],"title":"CompanySpendRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Spend.Request","x-validate":null}},"components/schemas/CompanyFieldSorts":{"id":"components/schemas/CompanyFieldSorts","kind":"json-schema","title":"CompanyFieldSorts","data":{"default":[{"direction":"ASC","field":"company_name"}],"description":"List of Sort objects","example":[{"direction":"DESC","field":"company_name"}],"items":{"$ref":"#/components/schemas/SortedCompanyField"},"title":"CompanyFieldSorts","type":"array","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Search.Sorts","x-validate":null}},"components/schemas/RangeFilter":{"id":"components/schemas/RangeFilter","kind":"json-schema","title":"RangeFilter","data":{"example":{"max":100,"min":25},"oneOf":[{"$ref":"#/components/schemas/MinFilter"},{"$ref":"#/components/schemas/MaxFilter"},{"$ref":"#/components/schemas/MinMaxFilter"}],"title":"RangeFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.RangeFilter","x-validate":null}},"components/schemas/CompanyIntentsSelectFields":{"id":"components/schemas/CompanyIntentsSelectFields","kind":"json-schema","title":"CompanyIntentsSelectFields","data":{"default":["topic_id","url","signal_strength","signal_trend"],"description":"A list of data points to be returned in the API response.","example":["topic_id","topic_name","url","signal_strength","signal_trend","location_strength","buyers_journey_name","context_name_array","state_name","country_name","region_name","datestamp"],"items":{"$ref":"#/components/schemas/CompanyIntentFieldNames"},"minItems":1,"nullable":false,"title":"CompanyIntentsSelectFields","type":"array","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Intent.SelectFields","x-validate":null}},"components/schemas/SelectedCompanySearchFields":{"id":"components/schemas/SelectedCompanySearchFields","kind":"json-schema","title":"SelectedCompanySearchFields","data":{"default":["company_id","company_name","domain_name","domain_name_normalized"],"description":"List of fields to be selected.","example":["company_id","company_name","domain_name","domain_name_normalized"],"items":{"$ref":"#/components/schemas/CompanySearchFieldNames"},"nullable":true,"title":"SelectedCompanySearchFields","type":"array","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Search.SelectFields","x-validate":null}},"components/schemas/ProductCategoriesFilter":{"id":"components/schemas/ProductCategoriesFilter","kind":"json-schema","title":"ProductCategoriesFilter","data":{"allOf":[{"$ref":"#/components/schemas/AnyNoneIdInclusionFilter"}],"description":"Filter by Product Category IDs","example":{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"ANY_PRESENT"},"title":"ProductCategoriesFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Install.Filters.ProductCategoriesFilter","x-validate":null}},"components/schemas/Limit":{"id":"components/schemas/Limit","kind":"json-schema","title":"Limit","data":{"default":10,"description":"The number of records to return in the request.","maximum":1000,"title":"Limit","type":"integer","x-struct":"Elixir.TalariaWeb.Schemas.Common.Pagination.Limit","x-validate":null}},"components/schemas/StatesResponse":{"id":"components/schemas/StatesResponse","kind":"json-schema","title":"StatesResponse","data":{"description":"Response schema for states","example":{"count":1,"data":[{"country":{"alpha2":"FR"},"id":"AEA8D2254D475DED13FD3F4339C6B8G","name":"Île-de-France"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/State"},"type":"array","x-struct":null,"x-validate":null}},"title":"StatesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.States.Response","x-validate":null}},"components/schemas/ProductCategory":{"id":"components/schemas/ProductCategory","kind":"json-schema","title":"ProductCategory","data":{"description":"Product Category schema","example":{"id":1,"name":"Cloud Computing"},"properties":{"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"Product Category name","type":"string","x-struct":null,"x-validate":null}},"required":["id","name"],"title":"ProductCategory","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.ProductCategories.ProductCategoryAttribute","x-validate":null}},"components/schemas/CompanySpendFieldNames":{"id":"components/schemas/CompanySpendFieldNames","kind":"json-schema","title":"CompanySpendFieldNames","data":{"description":"Allowed fields to be selected and returned in the response.","enum":["company_id","spend","category_id","category_name","category_description","country_code","country_name"],"title":"CompanySpendFieldNames","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Spend.SelectFields.FieldNames","x-validate":null}},"components/schemas/FAIDepartmentResponse":{"id":"components/schemas/FAIDepartmentResponse","kind":"json-schema","title":"FAIDepartmentResponse","data":{"description":"Response schema for FAI Department","example":{"count":1,"data":[{"id":"3FCEDF144BE9F3DFF1145DB6C515FB34","name":"Foo Bar","roles":[{"id":"3FCEDF144BE9F3DFF1145DB6C515FB35","name":"Fake Role"}]}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/FAIDepartment"},"type":"array","x-struct":null,"x-validate":null}},"title":"FAIDepartmentResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.FaiDepartments.Response","x-validate":null}},"components/schemas/IntentBuyersJourneyResponse":{"id":"components/schemas/IntentBuyersJourneyResponse","kind":"json-schema","title":"IntentBuyersJourneyResponse","data":{"description":"Response schema for Intent buyers journey","example":{"count":1,"data":[{"description":"Foo bar description","id":"2E64D9D97CF79E96941A831E40507CA2","name":"Evaluating"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/IntentBuyerJourney"},"type":"array","x-struct":null,"x-validate":null}},"title":"IntentBuyersJourneyResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.IntentBuyersJourney.Response","x-validate":null}},"components/schemas/InstallFieldNames":{"id":"components/schemas/InstallFieldNames","kind":"json-schema","title":"InstallFieldNames","data":{"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","product_category_level4_name","product_category_level5_name","product_attributes","product_first_verified_date","product_last_verified_date","product_intensity","product_locations","country_code"],"title":"InstallFieldNames","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.Install.SelectFields.FieldNames","x-validate":null}},"components/schemas/Offset":{"id":"components/schemas/Offset","kind":"json-schema","title":"Offset","data":{"default":0,"description":"Used for paginating records.","minimum":0,"title":"Offset","type":"integer","x-struct":"Elixir.TalariaWeb.Schemas.Common.Pagination.Offset","x-validate":null}},"components/schemas/NAICS2012Response":{"id":"components/schemas/NAICS2012Response","kind":"json-schema","title":"NAICS2012Response","data":{"description":"Response schema for NAICS 2012","example":{"count":1,"data":[{"code":"33636","id":"3FCEDF144BE9F3DFF1145DB6C515FB34","name":"Foo Bar","parentId":"264DD858DB942CAD06F24FF25DF56716"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/NAICS2012"},"type":"array","x-struct":null,"x-validate":null}},"title":"NAICS2012Response","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.Naics2012.Response","x-validate":null}},"components/schemas/FAIDepartment":{"id":"components/schemas/FAIDepartment","kind":"json-schema","title":"FAIDepartment","data":{"description":"FAI Department schema","example":{"id":"3FCEDF144BE9F3DFF1145DB6C515FB34","name":"Foo Bar","roles":[{"id":"3FCEDF144BE9F3DFF1145DB6C515FB35","name":"Fake Role"}]},"properties":{"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"FAI Department name","type":"string","x-struct":null,"x-validate":null},"roles":{"description":"FAI Roles. Note - not all departments have roles","items":{"$ref":"#/components/schemas/FAIRole"},"type":"array","x-struct":null,"x-validate":null}},"required":["id","name","roles"],"title":"FAIDepartment","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.FaiDepartments.FaiDepartment","x-validate":null}},"components/schemas/CompanySpendSortedSpendField":{"id":"components/schemas/CompanySpendSortedSpendField","kind":"json-schema","title":"CompanySpendSortedSpendField","data":{"example":{"direction":"DESC","field":"spend"},"properties":{"direction":{"$ref":"#/components/schemas/SortDirection"},"field":{"$ref":"#/components/schemas/CompanySpendSortFields"}},"required":["field","direction"],"title":"CompanySpendSortedSpendField","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Spend.Sorts.Sort","x-validate":null}},"components/schemas/IntentTopicsResponse":{"id":"components/schemas/IntentTopicsResponse","kind":"json-schema","title":"IntentTopicsResponse","data":{"description":"Response schema for Intent Topics","example":{"count":1,"data":[{"category":"technology","id":"3C974F539EF4BC6A0504AAB13C506780","name":"SysFoo"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/IntentTopic"},"type":"array","x-struct":null,"x-validate":null}},"title":"IntentTopicsResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.IntentTopics.Response","x-validate":null}},"components/schemas/CompanyObjectIdentifiers":{"id":"components/schemas/CompanyObjectIdentifiers","kind":"json-schema","title":"CompanyObjectIdentifiers","data":{"description":"A smaller object to identify a Company, no firmographic information.","properties":{"company_name":{"type":"string","x-struct":null,"x-validate":null},"domain_name":{"type":"string","x-struct":null,"x-validate":null},"domain_name_normalized":{"type":"string","x-struct":null,"x-validate":null},"hg_id":{"type":"string","x-struct":null,"x-validate":null}},"title":"CompanyObjectIdentifiers","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Object.Identifiers","x-validate":null}},"components/schemas/FAIRole":{"id":"components/schemas/FAIRole","kind":"json-schema","title":"FAIRole","data":{"description":"FAI Role schema","example":{"id":"3FCEDF144BE9F3DFF1145DB6C515FB34","name":"Fake Role"},"properties":{"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"FAI Role name","type":"string","x-struct":null,"x-validate":null}},"required":["id","name"],"title":"FAIRole","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.FaiDepartments.FaiRole","x-validate":null}},"components/schemas/AnyNoneNumericInclusionFilter":{"id":"components/schemas/AnyNoneNumericInclusionFilter","kind":"json-schema","title":"AnyNoneNumericInclusionFilter","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inclusion filter object using integer IDs. Can filter ids by ANY_PRESENT or NONE_PRESENT inclusion methods"},"children":[]}]}]}],"example":{"ids":[16994],"inclusion_method":"ANY_PRESENT"},"properties":{"ids":{"description":"Numeric IDs","items":{"type":"integer","x-struct":null,"x-validate":null},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"inclusion_method":{"$ref":"#/components/schemas/AnyNoneInclusionMethod"}},"required":["ids","inclusion_method"],"title":"AnyNoneNumericInclusionFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.AnyNoneNumericInclusionFilter","x-validate":null}},"components/schemas/CompanyIntentResponse":{"id":"components/schemas/CompanyIntentResponse","kind":"json-schema","title":"CompanyIntentResponse","data":{"description":"A list of intent data for a company and the full count of intent data.","properties":{"count":{"type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/CompanyIntentObject"},"type":"array","x-struct":null,"x-validate":null}},"title":"CompanyIntentResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Intent.Response","x-validate":null}},"components/schemas/InstallObject":{"id":"components/schemas/InstallObject","kind":"json-schema","title":"InstallObject","data":{"allOf":[{"$ref":"#/components/schemas/InstallObjectIdentifiers"}],"properties":{"product_attributes":{"items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"product_category_id":{"type":"string","x-struct":null,"x-validate":null},"product_category_level1_name":{"type":"string","x-struct":null,"x-validate":null},"product_category_level2_name":{"type":"string","x-struct":null,"x-validate":null},"product_category_level3_name":{"type":"string","x-struct":null,"x-validate":null},"product_category_level4_name":{"type":"string","x-struct":null,"x-validate":null},"product_category_level5_name":{"type":"string","x-struct":null,"x-validate":null},"product_description":{"type":"string","x-struct":null,"x-validate":null},"product_first_verified_date":{"format":"date","type":"string","x-struct":null,"x-validate":null},"product_intensity":{"type":"integer","x-struct":null,"x-validate":null},"product_last_verified_date":{"format":"date","type":"string","x-struct":null,"x-validate":null},"product_locations":{"type":"integer","x-struct":null,"x-validate":null},"vendor_domain_name":{"type":"string","x-struct":null,"x-validate":null},"vendor_id":{"type":"integer","x-struct":null,"x-validate":null},"vendor_name":{"type":"string","x-struct":null,"x-validate":null}},"title":"InstallObject","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Install.Object","x-validate":null}},"components/schemas/VendorsResponse":{"id":"components/schemas/VendorsResponse","kind":"json-schema","title":"VendorsResponse","data":{"description":"Response schema for vendors","example":{"count":1,"data":[{"id":"10056","name":"Vendor Name","url":"https://vendor.com"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/Vendor"},"type":"array","x-struct":null,"x-validate":null}},"title":"VendorsResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.Vendors.Response","x-validate":null}},"components/schemas/Company":{"id":"components/schemas/Company","kind":"json-schema","title":"Company","data":{"description":"Company schema","example":{"company_id":"6FA567B72D78B7E3EA746973FBBD1D5","company_name":"Adidas North America, Inc.","domain_name":"https://www.adidas.com"},"properties":{"company_id":{"description":"Company ID","type":"string","x-struct":null,"x-validate":null},"company_name":{"description":"Company name","type":"string","x-struct":null,"x-validate":null},"domain_name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company main domain_name"},"children":[]}]}]}],"type":"string","x-struct":null,"x-validate":null}},"required":["company_id","company_name","domain_name"],"title":"Company","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Companies.Company","x-validate":null}},"components/schemas/SICUS1987Response":{"id":"components/schemas/SICUS1987Response","kind":"json-schema","title":"SICUS1987Response","data":{"description":"Response schema for SIC US 1987","example":{"count":1,"data":[{"code":"33636","codeStandard":"5912","id":"3FCEDF144BE9F3DFF1145DB6C515FB34","name":"Foo Bar","parentId":"264DD858DB942CAD06F24FF25DF56716"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/SICUS1987"},"type":"array","x-struct":null,"x-validate":null}},"title":"SICUS1987Response","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.SicUS1987.Response","x-validate":null}},"components/schemas/ProductCategoriesResponse":{"id":"components/schemas/ProductCategoriesResponse","kind":"json-schema","title":"ProductCategoriesResponse","data":{"description":"Response schema for product categories","example":{"count":1,"data":[{"id":1,"name":"Cloud Computing"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/ProductCategory"},"type":"array","x-struct":null,"x-validate":null}},"title":"ProductCategoriesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Catalog.ProductCategories.Response","x-validate":null}},"components/schemas/CompanyInfoRequest":{"id":"components/schemas/CompanyInfoRequest","kind":"json-schema","title":"CompanyInfoRequest","data":{"description":"Find a company based on the input, and return all firmographic information about it.","properties":{"company_id":{"$ref":"#/components/schemas/Id"},"fields":{"$ref":"#/components/schemas/CompanyDataFields"}},"required":["company_id"],"title":"CompanyInfoRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Info.Request","x-validate":null}},"components/schemas/SortableInstallFields":{"id":"components/schemas/SortableInstallFields","kind":"json-schema","title":"SortableInstallFields","data":{"enum":["product_id","product_first_verified_date","product_last_verified_date","product_intensity","vendor_id"],"title":"SortableInstallFields","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.Install.Sorts.InstallSortField","x-validate":null}},"schema_15":{"kind":"json-schema","data":{"example":"Ford","type":"string","x-struct":null,"x-validate":null},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"example":"Ford Motor Company","type":"string","x-struct":null,"x-validate":null},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"example":"United States","type":"string","x-struct":null,"x-validate":null},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"example":"ford.com","type":"string","x-struct":null,"x-validate":null},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"example":10,"maximum":10,"minimum":1,"type":"integer","x-struct":null,"x-validate":null},"id":"schema_19"}},"exampleStore":{},"securitySchemeStore":{"authorization":{"id":"authorization","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api.hginsights.com"}]},"options":{"hideInfoSection":true,"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/v1/openapi.json?download"},{"url":"/_bundle/v1/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"HG Insights API V1","description":"# Overview of the HG Insights API\n\n**Note:** For new integrations, use [HG Insights API V2](/v2/openapi)\n\nThe 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.\n\nToday, 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.\n\n# Summary of Endpoints\n\n## Data Catalog API\n\nThis 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.\n\nClosely review the ReDoc/Swagger before making these calls, as some require additional inputs in the query parameters.\n\nThis catalog will generate lists for the following areas of the product:\n- Countries\n- FAI Departments\n- FAI Roles\n- Industries\n- Intent Buyers Journey\n- Intent Context Types\n- Intent Topics\n- NAICS 2012\n- Product Attributes\n- Product Categories\n- Products\n- SIC\n- Spend Categories\n- States\n- Vendors\n\n[Data Catalog](/v1/openapi/catalog)\n\n## Company Match API\n\nThis endpoint allows you to find entities in our dataset by name, country and/or URL.\n\nSome 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.\n\nThis 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.\n\n[Company Match API](/v1/openapi/company/find_companies)\n\n## Company Search API\n\nThis endpoint allows you to find companies based on our wide variety of search criteria.\n\nWe’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.\n\nPay 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.\n\n[Company Search API](/v1/openapi/company/search_companies)\n\n## Company Firmographics API\n\nThis 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.\n\nAn 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.\n\n[Company Firmographics API](/v1/openapi/company/company_info)\n\n## Company Installs API\n\nThis endpoint allows the user to retrieve product install information about a company.\n\nFilter your request by specific product datapoints relating to the id, name, vendor and category details, along with localization of the install.\n\nAn 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.\n\n[Company Installs API](/v1/openapi/company/company_installs)\n\n## Spend API\n\nThis endpoint allows the user to retrieve IT Spend Budget data about a company.\n\nRequests can be filtered to only specific IT Spend Budget categories, or all categories can be returned in the call.\n\nAn 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.\n\n[Spend API](/v1/openapi/company/company_spend)\n\n## Functional Area Intelligence\n\nHG 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.\n\nAn 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.\n\n[Functional Area Intelligence API](/v1/openapi/company/company_fai)\n\n## Intent API\n\nHG 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.\n\nA 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.\n\n# API Structure + Base URL\n\nThe API is structured around REST commands with HTTPS response codes to indicate either successful calls or errors produced.  Responses are all JSON objects.\n\nWhen making API requests in URL, you must do so over HTTPS - calls made over HTTP will fail.\n\n# Note: Configuration for Large Data Transfer\n\nSome 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](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding) header and specify a compression method, like gzip.\n\n# Tokens & Authentication\n\nTo 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.\n\n**Does the token rotate?:** This token will be refreshed periodically and should be used in the request header to authenticate the request.\n\n**How to Obtain a Token:** This token will be supplied to you via your CSM.\n\n**Security Best Practices:** Keep your API token confidential and regenerate tokens if compromised.  Use HTTPS for all API requests\n\n# API Errors\n\n## Error Codes\n\nThe API uses standard HTTP status codes to indicate the success or failure of a request.\n\n| Code | Description | Notes |\n|------|-------------|-------|\n| 200  | OK          |       |\n| 401  | Unauthorized | Probably a missing token or an invalid token |\n| 404  | Not found | The requested resource was not found |\n| 422 | Unprocessable Entity | Most likely the request body is invalid because of missing or invalid parameters validated by the Open API Spec |\n\n\n## Error messages\n\nThe error messages follow always the same pattern for syntax errors:\n\n```json\n{\n  \"errors\": [\n    {\n      \"title\": \"Invalid request\",\n      \"detail\": \"The request is invalid\",\n      \"source\": {\n        \"pointer\": \"/data/attributes/first-name\"\n      }\n    }\n  ]\n}\n```\n"}},"baseSlug":"/v1/openapi","routesMapping":{}}