{"items":[{"type":"link","label":"HG Insights API","link":"/v2/openapi","routeSlug":"/v2/openapi","content":{"contentType":"overview","meta":{"name":"HG Insights API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/v2/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/v2/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","showPageActions":true}],"sectionId":"/v2/openapi"}]}]}},{"type":"group","label":"Companies","link":"/v2/openapi/companies","routeSlug":"/v2/openapi/companies","items":[{"label":"Match Companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/companies/match_companies","routeSlug":"/v2/openapi/companies/match_companies","metadata":{"seo":{"title":"Match Companies","description":"Batch match up to 10 companies by name, domain, and/or country."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"match_companies","name":"Match Companies","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1companies~1match/post","hasSamples":true},"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":"Batch match up to 10 companies by name, domain, and/or country.\n\nEach company in the request must include at least one of: name, domain, country.\nResults are returned in the same order as the input, with each entry containing\nthe matched HG company records sorted by relevance.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompaniesMatchRequest"}},"schemaId":"components/schemas/CompaniesMatchRequest","pointer":"/paths/~1data-api~1v2~1companies~1match/post/requestBody","description":"Match Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/companies/match","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompaniesMatchRequest"}},"responseCodes":["200","401","422"],"pointer":"/data-api/v2/companies/match","href":"companies/match_companies","openApiOperationId":"match_companies","summary":"Match Companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompaniesMatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompaniesMatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Match Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompaniesMatchResponse"}},"schemaId":"components/schemas/CompaniesMatchResponse"},{"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~1v2~1companies~1match/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompaniesMatchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompaniesMatchResponse"}}},{"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/match_companies"}],"panels":[]}]},"httpPath":"/data-api/v2/companies/match"},{"label":"Estimate credit cost for Functional Area Intelligence","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/companies/estimate_functional_areas","routeSlug":"/v2/openapi/companies/estimate_functional_areas","metadata":{"seo":{"title":"Estimate credit cost for Functional Area Intelligence","description":"Returns the estimated credit cost for a Functional Area Intelligence (FAI) requestwithout consuming any credits or returning data. Use the same parameters as the/functional-areas endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"estimate_functional_areas","name":"Estimate credit cost for Functional Area Intelligence","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1companies~1functional-areas~1estimate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Estimate credit cost for Functional Area Intelligence","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the estimated credit cost for a Functional Area Intelligence (FAI) request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without consuming any credits or returning data. Use the same parameters as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/functional-areas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FunctionalAreasRequest"}},"schemaId":"components/schemas/FunctionalAreasRequest","pointer":"/paths/~1data-api~1v2~1companies~1functional-areas~1estimate/post/requestBody","description":"FAI estimate request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/companies/functional-areas/estimate","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FunctionalAreasRequest"}},"responseCodes":["200","401","422","503"],"pointer":"/data-api/v2/companies/functional-areas/estimate","href":"companies/estimate_functional_areas","openApiOperationId":"estimate_functional_areas","summary":"Estimate credit cost for Functional Area Intelligence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/FunctionalAreasRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FunctionalAreasRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Estimate response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FunctionalAreasEstimateResponse"}},"schemaId":"components/schemas/FunctionalAreasEstimateResponse"},{"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"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}},"schemaId":"components/schemas/ServiceUnavailableResponse"}],"pointer":"/paths/~1data-api~1v2~1companies~1functional-areas~1estimate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FunctionalAreasEstimateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FunctionalAreasEstimateResponse"}}},{"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"}}},{"code":"503","schemaId":"components/schemas/ServiceUnavailableResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/estimate_functional_areas"}],"panels":[]}]},"httpPath":"/data-api/v2/companies/functional-areas/estimate"},{"label":"Enrich Companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/companies/enrich_companies","routeSlug":"/v2/openapi/companies/enrich_companies","metadata":{"seo":{"title":"Enrich Companies","description":"Unified endpoint to enrich company data with firmographics, spend, technographics, and contracts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"enrich_companies","name":"Enrich Companies","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1companies~1enrich/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrich Companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unified endpoint to enrich company data with firmographics, spend, technographics, and contracts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Select which data categories to include using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter technographics by categories, vendors, or products using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Control pagination for both technographics and spend data using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure contracts options using the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sub-body."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contracts require the contracts entitlement."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompaniesEnrichRequest"}},"schemaId":"components/schemas/CompaniesEnrichRequest","pointer":"/paths/~1data-api~1v2~1companies~1enrich/post/requestBody","description":"Enrich Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/companies/enrich","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompaniesEnrichRequest"}},"responseCodes":["200","401","422","503"],"pointer":"/data-api/v2/companies/enrich","href":"companies/enrich_companies","openApiOperationId":"enrich_companies","summary":"Enrich Companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompaniesEnrichRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompaniesEnrichRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Enrich Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompaniesEnrichResponse"}},"schemaId":"components/schemas/CompaniesEnrichResponse"},{"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"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}},"schemaId":"components/schemas/ServiceUnavailableResponse"}],"pointer":"/paths/~1data-api~1v2~1companies~1enrich/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompaniesEnrichResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompaniesEnrichResponse"}}},{"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"}}},{"code":"503","schemaId":"components/schemas/ServiceUnavailableResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/enrich_companies"}],"panels":[]}]},"httpPath":"/data-api/v2/companies/enrich"},{"label":"Estimate credit cost for Company Hierarchy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/companies/estimate_company_hierarchy","routeSlug":"/v2/openapi/companies/estimate_company_hierarchy","metadata":{"seo":{"title":"Estimate credit cost for Company Hierarchy","description":"Returns the estimated credit cost for a Company Hierarchy request without consuming anycredits or returning data. Use the same parameters as the /hierarchy endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"estimate_company_hierarchy","name":"Estimate credit cost for Company Hierarchy","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1companies~1hierarchy~1estimate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Estimate credit cost for Company Hierarchy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the estimated credit cost for a Company Hierarchy request without consuming any"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credits or returning data. Use the same parameters as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/hierarchy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HierarchyRequest"}},"schemaId":"components/schemas/HierarchyRequest","pointer":"/paths/~1data-api~1v2~1companies~1hierarchy~1estimate/post/requestBody","description":"Hierarchy estimate request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/companies/hierarchy/estimate","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/HierarchyRequest"}},"responseCodes":["200","401","422","503"],"pointer":"/data-api/v2/companies/hierarchy/estimate","href":"companies/estimate_company_hierarchy","openApiOperationId":"estimate_company_hierarchy","summary":"Estimate credit cost for Company Hierarchy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/HierarchyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HierarchyRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Estimate response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyEstimateResponse"}},"schemaId":"components/schemas/HierarchyEstimateResponse"},{"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"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}},"schemaId":"components/schemas/ServiceUnavailableResponse"}],"pointer":"/paths/~1data-api~1v2~1companies~1hierarchy~1estimate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/HierarchyEstimateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyEstimateResponse"}}},{"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"}}},{"code":"503","schemaId":"components/schemas/ServiceUnavailableResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/estimate_company_hierarchy"}],"panels":[]}]},"httpPath":"/data-api/v2/companies/hierarchy/estimate"},{"label":"Estimate credit cost for company enrichment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/companies/estimate_companies_enrich","routeSlug":"/v2/openapi/companies/estimate_companies_enrich","metadata":{"seo":{"title":"Estimate credit cost for company enrichment","description":"Returns the estimated credit cost for a company enrichment request without consuming any credits or returning data. Use the same parameters as the enrich endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"estimate_companies_enrich","name":"Estimate credit cost for company enrichment","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1companies~1enrich~1estimate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Estimate credit cost for company enrichment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the estimated credit cost for a company enrichment request without consuming any credits\nor returning data. Use the same parameters as the enrich endpoint.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompaniesEnrichRequest"}},"schemaId":"components/schemas/CompaniesEnrichRequest","pointer":"/paths/~1data-api~1v2~1companies~1enrich~1estimate/post/requestBody","description":"Enrich estimate request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/companies/enrich/estimate","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompaniesEnrichRequest"}},"responseCodes":["200","401","422","503"],"pointer":"/data-api/v2/companies/enrich/estimate","href":"companies/estimate_companies_enrich","openApiOperationId":"estimate_companies_enrich","summary":"Estimate credit cost for company enrichment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompaniesEnrichRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompaniesEnrichRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Estimate response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompaniesEnrichEstimateResponse"}},"schemaId":"components/schemas/CompaniesEnrichEstimateResponse"},{"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"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}},"schemaId":"components/schemas/ServiceUnavailableResponse"}],"pointer":"/paths/~1data-api~1v2~1companies~1enrich~1estimate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompaniesEnrichEstimateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompaniesEnrichEstimateResponse"}}},{"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"}}},{"code":"503","schemaId":"components/schemas/ServiceUnavailableResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/estimate_companies_enrich"}],"panels":[]}]},"httpPath":"/data-api/v2/companies/enrich/estimate"},{"label":"Company Hierarchy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/companies/company_hierarchy","routeSlug":"/v2/openapi/companies/company_hierarchy","metadata":{"seo":{"title":"Company Hierarchy","description":"Returns the company hierarchy as a nested tree (format: tree, default) or a flat list (format: list)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"company_hierarchy","name":"Company Hierarchy","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1companies~1hierarchy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Hierarchy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the company hierarchy as a nested tree ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format: tree"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", default) or a flat list ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format: list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to control the traversal: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns the entire tree from Group HQ, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"children"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns the subtree rooted at the matched company, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns the ancestor chain from Group HQ to the matched company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter compatibility by format: the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tiers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters require "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format: list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and return HTTP 400 ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FILTER_NOT_VALID_FOR_TREE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") when used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format: tree"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (including the default when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted). The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_tier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter works with both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tree"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and can be used to limit tree depth."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HierarchyRequest"}},"schemaId":"components/schemas/HierarchyRequest","pointer":"/paths/~1data-api~1v2~1companies~1hierarchy/post/requestBody","description":"Hierarchy Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/companies/hierarchy","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/HierarchyRequest"}},"responseCodes":["200","401","422"],"pointer":"/data-api/v2/companies/hierarchy","href":"companies/company_hierarchy","openApiOperationId":"company_hierarchy","summary":"Company Hierarchy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/HierarchyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HierarchyRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Hierarchy Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyResponse"}},"schemaId":"components/schemas/HierarchyResponse"},{"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~1v2~1companies~1hierarchy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/HierarchyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyResponse"}}},{"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/company_hierarchy"}],"panels":[]}]},"httpPath":"/data-api/v2/companies/hierarchy"},{"label":"Company Functional Area Intelligence","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/companies/get_functional_areas","routeSlug":"/v2/openapi/companies/get_functional_areas","metadata":{"seo":{"title":"Company Functional Area Intelligence","description":"Returns Functional Area Intelligence (FAI) for a company. FAI predicts where detectedtechnologies are used at both a departmental and location-specific level within an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_functional_areas","name":"Company Functional Area Intelligence","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1companies~1functional-areas/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Functional Area Intelligence","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns Functional Area Intelligence (FAI) for a company. FAI predicts where detected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"technologies are used at both a departmental and location-specific level within an organization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the company by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (hex-encoded) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All filters are optional."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FunctionalAreasRequest"}},"schemaId":"components/schemas/FunctionalAreasRequest","pointer":"/paths/~1data-api~1v2~1companies~1functional-areas/post/requestBody","description":"FAI Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/companies/functional-areas","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FunctionalAreasRequest"}},"responseCodes":["200","401","422","503"],"pointer":"/data-api/v2/companies/functional-areas","href":"companies/get_functional_areas","openApiOperationId":"get_functional_areas","summary":"Company Functional Area Intelligence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/FunctionalAreasRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FunctionalAreasRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"FAI Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FunctionalAreasResponse"}},"schemaId":"components/schemas/FunctionalAreasResponse"},{"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"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}},"schemaId":"components/schemas/ServiceUnavailableResponse"}],"pointer":"/paths/~1data-api~1v2~1companies~1functional-areas/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FunctionalAreasResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FunctionalAreasResponse"}}},{"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"}}},{"code":"503","schemaId":"components/schemas/ServiceUnavailableResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/get_functional_areas"}],"panels":[]}]},"httpPath":"/data-api/v2/companies/functional-areas"},{"label":"Search Companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/companies/search_companies_v2","routeSlug":"/v2/openapi/companies/search_companies_v2","metadata":{"seo":{"title":"Search Companies","description":"Search and filter companies. Returns a paginated list of companies matching the filter criteria."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_companies_v2","name":"Search Companies","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1companies~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search and filter companies. Returns a paginated list of companies matching the filter criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intent topic filtering is unrestricted — all intent topics are available regardless of provisioning."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompaniesSearchRequest"}},"schemaId":"components/schemas/CompaniesSearchRequest","pointer":"/paths/~1data-api~1v2~1companies~1search/post/requestBody","description":"Search Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/companies/search","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompaniesSearchRequest"}},"responseCodes":["200","401","422"],"pointer":"/data-api/v2/companies/search","href":"companies/search_companies_v2","openApiOperationId":"search_companies_v2","summary":"Search Companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/CompaniesSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompaniesSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Search Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompaniesSearchResponse"}},"schemaId":"components/schemas/CompaniesSearchResponse"},{"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~1v2~1companies~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompaniesSearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompaniesSearchResponse"}}},{"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/search_companies_v2"}],"panels":[]}]},"httpPath":"/data-api/v2/companies/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/v2/companies/match","summary":"Match Companies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/match_companies","deprecated":false},{"title":"/data-api/v2/companies/functional-areas/estimate","summary":"Estimate credit cost for Functional Area Intelligence","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/estimate_functional_areas","deprecated":false},{"title":"/data-api/v2/companies/enrich","summary":"Enrich Companies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/enrich_companies","deprecated":false},{"title":"/data-api/v2/companies/hierarchy/estimate","summary":"Estimate credit cost for Company Hierarchy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/estimate_company_hierarchy","deprecated":false},{"title":"/data-api/v2/companies/enrich/estimate","summary":"Estimate credit cost for company enrichment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/estimate_companies_enrich","deprecated":false},{"title":"/data-api/v2/companies/hierarchy","summary":"Company Hierarchy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/company_hierarchy","deprecated":false},{"title":"/data-api/v2/companies/functional-areas","summary":"Company Functional Area Intelligence","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/get_functional_areas","deprecated":false},{"title":"/data-api/v2/companies/search","summary":"Search Companies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/search_companies_v2","deprecated":false}]}]}]}]}},{"type":"group","label":"Contacts","link":"/v2/openapi/contacts","routeSlug":"/v2/openapi/contacts","items":[{"label":"Enrich Contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/contacts/enrich_contacts_v2","routeSlug":"/v2/openapi/contacts/enrich_contacts_v2","metadata":{"seo":{"title":"Enrich Contacts","description":"Enrich contacts with PII fields (email, phone) by ID. A maximum of 20 IDs may be enriched per request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"enrich_contacts_v2","name":"Enrich Contacts","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1contacts~1enrich/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrich Contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Enrich contacts with PII fields (email, phone) by ID. A maximum of 20 IDs may be enriched per request.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactsEnrichRequest"}},"schemaId":"components/schemas/ContactsEnrichRequest","pointer":"/paths/~1data-api~1v2~1contacts~1enrich/post/requestBody","description":"Enrich Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/contacts/enrich","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactsEnrichRequest"}},"responseCodes":["200","401","422"],"pointer":"/data-api/v2/contacts/enrich","href":"contacts/enrich_contacts_v2","openApiOperationId":"enrich_contacts_v2","summary":"Enrich Contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/ContactsEnrichRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactsEnrichRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Enrich Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactsEnrichResponse"}},"schemaId":"components/schemas/ContactsEnrichResponse"},{"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~1v2~1contacts~1enrich/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactsEnrichResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactsEnrichResponse"}}},{"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":"/contacts/enrich_contacts_v2"}],"panels":[]}]},"httpPath":"/data-api/v2/contacts/enrich"},{"label":"Estimate credit cost for contact enrichment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/contacts/estimate_contacts_enrich","routeSlug":"/v2/openapi/contacts/estimate_contacts_enrich","metadata":{"seo":{"title":"Estimate credit cost for contact enrichment","description":"Returns the estimated credit cost for a contact enrichment request without consuming any credits or returning data. Use the same parameters as the enrich endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"estimate_contacts_enrich","name":"Estimate credit cost for contact enrichment","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1contacts~1enrich~1estimate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Estimate credit cost for contact enrichment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the estimated credit cost for a contact enrichment request without consuming any credits\nor returning data. Use the same parameters as the enrich endpoint.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactsEnrichRequest"}},"schemaId":"components/schemas/ContactsEnrichRequest","pointer":"/paths/~1data-api~1v2~1contacts~1enrich~1estimate/post/requestBody","description":"Enrich estimate request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/contacts/enrich/estimate","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactsEnrichRequest"}},"responseCodes":["200","401","422","503"],"pointer":"/data-api/v2/contacts/enrich/estimate","href":"contacts/estimate_contacts_enrich","openApiOperationId":"estimate_contacts_enrich","summary":"Estimate credit cost for contact enrichment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/ContactsEnrichRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactsEnrichRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Estimate response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactsEnrichEstimateResponse"}},"schemaId":"components/schemas/ContactsEnrichEstimateResponse"},{"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"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}},"schemaId":"components/schemas/ServiceUnavailableResponse"}],"pointer":"/paths/~1data-api~1v2~1contacts~1enrich~1estimate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactsEnrichEstimateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactsEnrichEstimateResponse"}}},{"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"}}},{"code":"503","schemaId":"components/schemas/ServiceUnavailableResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/estimate_contacts_enrich"}],"panels":[]}]},"httpPath":"/data-api/v2/contacts/enrich/estimate"},{"label":"Search Contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/contacts/search_contacts_v2","routeSlug":"/v2/openapi/contacts/search_contacts_v2","metadata":{"seo":{"title":"Search Contacts","description":"Search and filter contacts. Returns a flat list of matching contacts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_contacts_v2","name":"Search Contacts","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1contacts~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search and filter contacts. Returns a flat list of matching contacts.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactsSearchRequest"}},"schemaId":"components/schemas/ContactsSearchRequest","pointer":"/paths/~1data-api~1v2~1contacts~1search/post/requestBody","description":"Search Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/contacts/search","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactsSearchRequest"}},"responseCodes":["200","401","422"],"pointer":"/data-api/v2/contacts/search","href":"contacts/search_contacts_v2","openApiOperationId":"search_contacts_v2","summary":"Search Contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/ContactsSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactsSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Search Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactsSearchResponse"}},"schemaId":"components/schemas/ContactsSearchResponse"},{"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~1v2~1contacts~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactsSearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactsSearchResponse"}}},{"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":"/contacts/search_contacts_v2"}],"panels":[]}]},"httpPath":"/data-api/v2/contacts/search"}],"content":{"contentType":"group","meta":{"name":"Contacts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contacts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v2/contacts/enrich","summary":"Enrich Contacts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/enrich_contacts_v2","deprecated":false},{"title":"/data-api/v2/contacts/enrich/estimate","summary":"Estimate credit cost for contact enrichment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/estimate_contacts_enrich","deprecated":false},{"title":"/data-api/v2/contacts/search","summary":"Search Contacts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/search_contacts_v2","deprecated":false}]}]}]}]}},{"type":"group","label":"Intent","link":"/v2/openapi/intent","routeSlug":"/v2/openapi/intent","items":[{"label":"Estimate Credits for Company Intent Signals","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/intent/intent_enrich_estimate","routeSlug":"/v2/openapi/intent/intent_enrich_estimate","metadata":{"seo":{"title":"Estimate Credits for Company Intent Signals","description":"Returns a credits estimate for an intent enrich request without consuming credits. Provides a breakdown by topics and activities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"intent_enrich_estimate","name":"Estimate Credits for Company Intent Signals","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1intent~1enrich~1estimate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Estimate Credits for Company Intent Signals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a credits estimate for an intent enrich request without consuming credits.\nProvides a breakdown by topics and activities.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IntentRequest"}},"schemaId":"components/schemas/IntentRequest","pointer":"/paths/~1data-api~1v2~1intent~1enrich~1estimate/post/requestBody","description":"Intent Estimate Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/intent/enrich/estimate","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IntentRequest"}},"responseCodes":["200","401","404","422","503"],"pointer":"/data-api/v2/intent/enrich/estimate","href":"intent/intent_enrich_estimate","openApiOperationId":"intent_enrich_estimate","summary":"Estimate Credits for Company Intent Signals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/IntentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IntentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Intent Estimate Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentEstimateResponse"}},"schemaId":"components/schemas/IntentEstimateResponse"},{"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"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}},"schemaId":"components/schemas/ServiceUnavailableResponse"}],"pointer":"/paths/~1data-api~1v2~1intent~1enrich~1estimate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IntentEstimateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentEstimateResponse"}}},{"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"}}},{"code":"503","schemaId":"components/schemas/ServiceUnavailableResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/intent/intent_enrich_estimate"}],"panels":[]}]},"httpPath":"/data-api/v2/intent/enrich/estimate"},{"label":"Get Company Intent Signals","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/intent/intent_enrich","routeSlug":"/v2/openapi/intent/intent_enrich","metadata":{"seo":{"title":"Get Company Intent Signals","description":"Returns intent signals for a known company. Combines HG topic-based intentand TrustRadius buyer-intent activities. Provide the company by id(hex-encoded) or domain. All filters are optional."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"intent_enrich","name":"Get Company Intent Signals","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1intent~1enrich/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company Intent Signals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns intent signals for a known company. Combines HG topic-based intent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and TrustRadius buyer-intent activities. Provide the company by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(hex-encoded) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All filters are optional."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IntentRequest"}},"schemaId":"components/schemas/IntentRequest","pointer":"/paths/~1data-api~1v2~1intent~1enrich/post/requestBody","description":"Intent Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/intent/enrich","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IntentRequest"}},"responseCodes":["200","401","404","422","503"],"pointer":"/data-api/v2/intent/enrich","href":"intent/intent_enrich","openApiOperationId":"intent_enrich","summary":"Get Company Intent Signals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/IntentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IntentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Intent Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentResponse"}},"schemaId":"components/schemas/IntentResponse"},{"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"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}},"schemaId":"components/schemas/ServiceUnavailableResponse"}],"pointer":"/paths/~1data-api~1v2~1intent~1enrich/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IntentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IntentResponse"}}},{"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"}}},{"code":"503","schemaId":"components/schemas/ServiceUnavailableResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/intent/intent_enrich"}],"panels":[]}]},"httpPath":"/data-api/v2/intent/enrich"}],"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/v2/intent/enrich/estimate","summary":"Estimate Credits for Company Intent Signals","prefix":{"name":"post","color":"post"},"badges":[],"link":"/intent/intent_enrich_estimate","deprecated":false},{"title":"/data-api/v2/intent/enrich","summary":"Get Company Intent Signals","prefix":{"name":"post","color":"post"},"badges":[],"link":"/intent/intent_enrich","deprecated":false}]}]}]}]}},{"type":"group","label":"Contracts","link":"/v2/openapi/contracts","routeSlug":"/v2/openapi/contracts","items":[{"label":"Search Contracts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/contracts/search_contracts","routeSlug":"/v2/openapi/contracts/search_contracts","metadata":{"seo":{"title":"Search Contracts","description":"Search and filter contracts. Returns a paginated list of contracts matching the filter criteria."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_contracts","name":"Search Contracts","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1contracts~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Contracts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search and filter contracts. Returns a paginated list of contracts matching the filter criteria."},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractSearchRequest"}},"schemaId":"components/schemas/ContractSearchRequest","pointer":"/paths/~1data-api~1v2~1contracts~1search/post/requestBody","description":"Search Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/contracts/search","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContractSearchRequest"}},"responseCodes":["200","401","422"],"pointer":"/data-api/v2/contracts/search","href":"contracts/search_contracts","openApiOperationId":"search_contracts","summary":"Search Contracts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/ContractSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Search Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractSearchResponse"}},"schemaId":"components/schemas/ContractSearchResponse"},{"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~1v2~1contracts~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContractSearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractSearchResponse"}}},{"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":"/contracts/search_contracts"}],"panels":[]}]},"httpPath":"/data-api/v2/contracts/search"},{"label":"Estimate credit cost for Contract Search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/contracts/estimate_contract_search","routeSlug":"/v2/openapi/contracts/estimate_contract_search","metadata":{"seo":{"title":"Estimate credit cost for Contract Search","description":"Returns the estimated credit cost for a contract search request without consuming anycredits or returning data. Use the same filter parameters as the /search endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"estimate_contract_search","name":"Estimate credit cost for Contract Search","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1contracts~1search~1estimate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Estimate credit cost for Contract Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the estimated credit cost for a contract search request without consuming any"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credits or returning data. Use the same filter parameters as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractSearchEstimateRequest"}},"schemaId":"components/schemas/ContractSearchEstimateRequest","pointer":"/paths/~1data-api~1v2~1contracts~1search~1estimate/post/requestBody","description":"Estimate Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/contracts/search/estimate","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContractSearchEstimateRequest"}},"responseCodes":["200","401","422","503"],"pointer":"/data-api/v2/contracts/search/estimate","href":"contracts/estimate_contract_search","openApiOperationId":"estimate_contract_search","summary":"Estimate credit cost for Contract Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/ContractSearchEstimateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContractSearchEstimateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Estimate Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractSearchEstimateResponse"}},"schemaId":"components/schemas/ContractSearchEstimateResponse"},{"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"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}},"schemaId":"components/schemas/ServiceUnavailableResponse"}],"pointer":"/paths/~1data-api~1v2~1contracts~1search~1estimate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContractSearchEstimateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractSearchEstimateResponse"}}},{"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"}}},{"code":"503","schemaId":"components/schemas/ServiceUnavailableResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/estimate_contract_search"}],"panels":[]}]},"httpPath":"/data-api/v2/contracts/search/estimate"}],"content":{"contentType":"group","meta":{"name":"Contracts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contracts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v2/contracts/search","summary":"Search Contracts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contracts/search_contracts","deprecated":false},{"title":"/data-api/v2/contracts/search/estimate","summary":"Estimate credit cost for Contract Search","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contracts/estimate_contract_search","deprecated":false}]}]}]}]}},{"type":"group","label":"Catalog","link":"/v2/openapi/catalog","routeSlug":"/v2/openapi/catalog","items":[{"label":"List intent buyers journey","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_intent_buyers_journey","routeSlug":"/v2/openapi/catalog/v2_list_intent_buyers_journey","metadata":{"seo":{"title":"List intent buyers journey","description":"List all intent buyers journey stages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_intent_buyers_journey","name":"List intent buyers journey","isWebhook":false,"pointer":"/paths/~1data-api~1v2~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 stages"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1intent_buyers_journey/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/intent_buyers_journey","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/intent_buyers_journey","href":"catalog/v2_list_intent_buyers_journey","openApiOperationId":"v2_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/V2IntentBuyersJourneyResponse"}},"schemaId":"components/schemas/V2IntentBuyersJourneyResponse"},{"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~1v2~1catalog~1intent_buyers_journey/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2IntentBuyersJourneyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2IntentBuyersJourneyResponse"}}},{"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/v2_list_intent_buyers_journey"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/intent_buyers_journey"},{"label":"List NAICS 2012","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_naics2012","routeSlug":"/v2/openapi/catalog/v2_list_naics2012","metadata":{"seo":{"title":"List NAICS 2012","description":"List all NAICS 2012"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_naics2012","name":"List NAICS 2012","isWebhook":false,"pointer":"/paths/~1data-api~1v2~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","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1naics2012/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/naics2012","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/naics2012","href":"catalog/v2_list_naics2012","openApiOperationId":"v2_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/V2NAICS2012Response"}},"schemaId":"components/schemas/V2NAICS2012Response"},{"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~1v2~1catalog~1naics2012/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2NAICS2012Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2NAICS2012Response"}}},{"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/v2_list_naics2012"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/naics2012"},{"label":"List vendors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_vendors","routeSlug":"/v2/openapi/catalog/v2_list_vendors","metadata":{"seo":{"title":"List vendors","description":"List vendors, optionally filtered by name"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_vendors","name":"List vendors","isWebhook":false,"pointer":"/paths/~1data-api~1v2~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, optionally filtered by name"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1vendors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/vendors","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/vendors","href":"catalog/v2_list_vendors","openApiOperationId":"v2_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/V2VendorsResponse"}},"schemaId":"components/schemas/V2VendorsResponse"},{"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~1v2~1catalog~1vendors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2VendorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2VendorsResponse"}}},{"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/v2_list_vendors"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/vendors"},{"label":"List job functions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_job_functions","routeSlug":"/v2/openapi/catalog/v2_list_job_functions","metadata":{"seo":{"title":"List job functions","description":"List all job functions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_job_functions","name":"List job functions","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1catalog~1job_functions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List job functions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all job functions"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1job_functions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/job_functions","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/job_functions","href":"catalog/v2_list_job_functions","openApiOperationId":"v2_list_job_functions","summary":"List job functions"},"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":"Job Functions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2JobFunctionsResponse"}},"schemaId":"components/schemas/V2JobFunctionsResponse"},{"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~1v2~1catalog~1job_functions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2JobFunctionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2JobFunctionsResponse"}}},{"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/v2_list_job_functions"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/job_functions"},{"label":"List SIC US 1987","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_sicus1987","routeSlug":"/v2/openapi/catalog/v2_list_sicus1987","metadata":{"seo":{"title":"List SIC US 1987","description":"List all SIC US 1987"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_sicus1987","name":"List SIC US 1987","isWebhook":false,"pointer":"/paths/~1data-api~1v2~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","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1sicus1987/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/sicus1987","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/sicus1987","href":"catalog/v2_list_sicus1987","openApiOperationId":"v2_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/V2SICUS1987Response"}},"schemaId":"components/schemas/V2SICUS1987Response"},{"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~1v2~1catalog~1sicus1987/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2SICUS1987Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2SICUS1987Response"}}},{"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/v2_list_sicus1987"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/sicus1987"},{"label":"List intent context types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_intent_context_types","routeSlug":"/v2/openapi/catalog/v2_list_intent_context_types","metadata":{"seo":{"title":"List intent context types","description":"List all intent context types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_intent_context_types","name":"List intent context types","isWebhook":false,"pointer":"/paths/~1data-api~1v2~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","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1intent_context_types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/intent_context_types","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/intent_context_types","href":"catalog/v2_list_intent_context_types","openApiOperationId":"v2_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/V2IntentContextTypesResponse"}},"schemaId":"components/schemas/V2IntentContextTypesResponse"},{"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~1v2~1catalog~1intent_context_types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2IntentContextTypesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2IntentContextTypesResponse"}}},{"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/v2_list_intent_context_types"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/intent_context_types"},{"label":"List product categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_product_categories","routeSlug":"/v2/openapi/catalog/v2_list_product_categories","metadata":{"seo":{"title":"List product categories","description":"List all product categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_product_categories","name":"List product categories","isWebhook":false,"pointer":"/paths/~1data-api~1v2~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","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1product_categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/product_categories","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/product_categories","href":"catalog/v2_list_product_categories","openApiOperationId":"v2_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/V2ProductCategoriesResponse"}},"schemaId":"components/schemas/V2ProductCategoriesResponse"},{"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~1v2~1catalog~1product_categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2ProductCategoriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2ProductCategoriesResponse"}}},{"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/v2_list_product_categories"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/product_categories"},{"label":"List states","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_states","routeSlug":"/v2/openapi/catalog/v2_list_states","metadata":{"seo":{"title":"List states","description":"List all states"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_states","name":"List states","isWebhook":false,"pointer":"/paths/~1data-api~1v2~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","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"},{"name":"country_code","in":"query","schemaId":"schema_22","description":"Filter by country code (exact match, e.g. \"US\")"}],"pointer":"/paths/~1data-api~1v2~1catalog~1states/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/states","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"},{"name":"country_code","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/states","href":"catalog/v2_list_states","openApiOperationId":"v2_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/V2StatesResponse"}},"schemaId":"components/schemas/V2StatesResponse"},{"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~1v2~1catalog~1states/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2StatesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2StatesResponse"}}},{"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/v2_list_states"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/states"},{"label":"List industries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_industries","routeSlug":"/v2/openapi/catalog/v2_list_industries","metadata":{"seo":{"title":"List industries","description":"List all industries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_industries","name":"List industries","isWebhook":false,"pointer":"/paths/~1data-api~1v2~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","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1industries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/industries","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/industries","href":"catalog/v2_list_industries","openApiOperationId":"v2_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/V2IndustriesResponse"}},"schemaId":"components/schemas/V2IndustriesResponse"},{"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~1v2~1catalog~1industries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2IndustriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2IndustriesResponse"}}},{"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/v2_list_industries"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/industries"},{"label":"List FAI departments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_fai_departments","routeSlug":"/v2/openapi/catalog/v2_list_fai_departments","metadata":{"seo":{"title":"List FAI departments","description":"List all FAI departments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_fai_departments","name":"List FAI departments","isWebhook":false,"pointer":"/paths/~1data-api~1v2~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","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1fai_departments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/fai_departments","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/fai_departments","href":"catalog/v2_list_fai_departments","openApiOperationId":"v2_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/V2FAIDepartmentsResponse"}},"schemaId":"components/schemas/V2FAIDepartmentsResponse"},{"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~1v2~1catalog~1fai_departments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2FAIDepartmentsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2FAIDepartmentsResponse"}}},{"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/v2_list_fai_departments"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/fai_departments"},{"label":"List spend categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_spend_categories","routeSlug":"/v2/openapi/catalog/v2_list_spend_categories","metadata":{"seo":{"title":"List spend categories","description":"List all spend categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_spend_categories","name":"List spend categories","isWebhook":false,"pointer":"/paths/~1data-api~1v2~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","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1spend_categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/spend_categories","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/spend_categories","href":"catalog/v2_list_spend_categories","openApiOperationId":"v2_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/V2SpendCategoriesResponse"}},"schemaId":"components/schemas/V2SpendCategoriesResponse"},{"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~1v2~1catalog~1spend_categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2SpendCategoriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2SpendCategoriesResponse"}}},{"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/v2_list_spend_categories"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/spend_categories"},{"label":"List countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_countries","routeSlug":"/v2/openapi/catalog/v2_list_countries","metadata":{"seo":{"title":"List countries","description":"List all countries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_countries","name":"List countries","isWebhook":false,"pointer":"/paths/~1data-api~1v2~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","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1countries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/countries","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/countries","href":"catalog/v2_list_countries","openApiOperationId":"v2_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/V2CountriesResponse"}},"schemaId":"components/schemas/V2CountriesResponse"},{"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~1v2~1catalog~1countries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2CountriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2CountriesResponse"}}},{"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/v2_list_countries"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/countries"},{"label":"List product attributes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_product_attributes","routeSlug":"/v2/openapi/catalog/v2_list_product_attributes","metadata":{"seo":{"title":"List product attributes","description":"List all product attributes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_product_attributes","name":"List product attributes","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1catalog~1product_attributes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List product attributes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all product attributes"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1product_attributes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/product_attributes","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/product_attributes","href":"catalog/v2_list_product_attributes","openApiOperationId":"v2_list_product_attributes","summary":"List product 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":"Product Attributes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2ProductAttributesResponse"}},"schemaId":"components/schemas/V2ProductAttributesResponse"},{"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~1v2~1catalog~1product_attributes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2ProductAttributesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2ProductAttributesResponse"}}},{"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/v2_list_product_attributes"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/product_attributes"},{"label":"List intent topics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_intent_topics","routeSlug":"/v2/openapi/catalog/v2_list_intent_topics","metadata":{"seo":{"title":"List intent topics","description":"List all intent topics"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_intent_topics","name":"List intent topics","isWebhook":false,"pointer":"/paths/~1data-api~1v2~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","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1intent_topics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/intent_topics","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/intent_topics","href":"catalog/v2_list_intent_topics","openApiOperationId":"v2_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/V2IntentTopicsResponse"}},"schemaId":"components/schemas/V2IntentTopicsResponse"},{"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~1v2~1catalog~1intent_topics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2IntentTopicsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2IntentTopicsResponse"}}},{"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/v2_list_intent_topics"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/intent_topics"},{"label":"List products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_products","routeSlug":"/v2/openapi/catalog/v2_list_products","metadata":{"seo":{"title":"List products","description":"List all products"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_products","name":"List products","isWebhook":false,"pointer":"/paths/~1data-api~1v2~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","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_20","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/products","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_20"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/products","href":"catalog/v2_list_products","openApiOperationId":"v2_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/V2ProductsResponse"}},"schemaId":"components/schemas/V2ProductsResponse"},{"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~1v2~1catalog~1products/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2ProductsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2ProductsResponse"}}},{"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/v2_list_products"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/products"},{"label":"List job seniorities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/catalog/v2_list_job_seniorities","routeSlug":"/v2/openapi/catalog/v2_list_job_seniorities","metadata":{"seo":{"title":"List job seniorities","description":"List all job seniorities"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_list_job_seniorities","name":"List job seniorities","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1catalog~1job_seniorities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List job seniorities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all job seniorities"},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_23","description":"The number of records to return"},{"name":"offset","in":"query","schemaId":"schema_21","description":"The number of records to skip"},{"name":"name","in":"query","schemaId":"schema_22","description":"Filter by name (case-insensitive partial match)"}],"pointer":"/paths/~1data-api~1v2~1catalog~1job_seniorities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/catalog/job_seniorities","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_23"},{"name":"offset","in":"query","required":false,"schemaId":"schema_21"},{"name":"name","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/catalog/job_seniorities","href":"catalog/v2_list_job_seniorities","openApiOperationId":"v2_list_job_seniorities","summary":"List job seniorities"},"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":"Job Seniorities","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2JobSenioritiesResponse"}},"schemaId":"components/schemas/V2JobSenioritiesResponse"},{"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~1v2~1catalog~1job_seniorities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/V2JobSenioritiesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V2JobSenioritiesResponse"}}},{"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/v2_list_job_seniorities"}],"panels":[]}]},"httpPath":"/data-api/v2/catalog/job_seniorities"}],"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/v2/catalog/intent_buyers_journey","summary":"List intent buyers journey","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_intent_buyers_journey","deprecated":false},{"title":"/data-api/v2/catalog/naics2012","summary":"List NAICS 2012","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_naics2012","deprecated":false},{"title":"/data-api/v2/catalog/vendors","summary":"List vendors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_vendors","deprecated":false},{"title":"/data-api/v2/catalog/job_functions","summary":"List job functions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_job_functions","deprecated":false},{"title":"/data-api/v2/catalog/sicus1987","summary":"List SIC US 1987","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_sicus1987","deprecated":false},{"title":"/data-api/v2/catalog/intent_context_types","summary":"List intent context types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_intent_context_types","deprecated":false},{"title":"/data-api/v2/catalog/product_categories","summary":"List product categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_product_categories","deprecated":false},{"title":"/data-api/v2/catalog/states","summary":"List states","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_states","deprecated":false},{"title":"/data-api/v2/catalog/industries","summary":"List industries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_industries","deprecated":false},{"title":"/data-api/v2/catalog/fai_departments","summary":"List FAI departments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_fai_departments","deprecated":false},{"title":"/data-api/v2/catalog/spend_categories","summary":"List spend categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_spend_categories","deprecated":false},{"title":"/data-api/v2/catalog/countries","summary":"List countries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_countries","deprecated":false},{"title":"/data-api/v2/catalog/product_attributes","summary":"List product attributes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_product_attributes","deprecated":false},{"title":"/data-api/v2/catalog/intent_topics","summary":"List intent topics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_intent_topics","deprecated":false},{"title":"/data-api/v2/catalog/products","summary":"List products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_products","deprecated":false},{"title":"/data-api/v2/catalog/job_seniorities","summary":"List job seniorities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/v2_list_job_seniorities","deprecated":false}]}]}]}]}},{"type":"group","label":"Industries","link":"/v2/openapi/industries","routeSlug":"/v2/openapi/industries","items":[{"label":"Search industries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/industries/v2_search_industries","routeSlug":"/v2/openapi/industries/v2_search_industries","metadata":{"seo":{"title":"Search industries","description":"Search the industry taxonomy crosswalk across HG industry (23 buckets),NAICS 2012 (~2,200 codes), and SIC 1987 (~1,500 codes)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_search_industries","name":"Search industries","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1industries~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search industries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search the industry taxonomy crosswalk across HG industry (23 buckets),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NAICS 2012 (~2,200 codes), and SIC 1987 (~1,500 codes)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports free-text search, exact code lookup, taxonomy scoping,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"colloquial alias expansion (e.g. \"fintech\", \"saas\"), and multi-term"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"comma-separated queries."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every result row returns the full crosswalk — the HG industry, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NAICS 2012 code + top-parent sector, and the SIC 1987 code + name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free — no credits consumed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"q","in":"query","schemaId":"schema_24","description":"Free-text search term (min 2 chars). Text queries match case-insensitively as substrings. All-digit queries prefix-match against code columns. Comma-separated terms run as union (OR). Colloquial terms like 'fintech', 'saas' are auto-expanded."},{"name":"taxonomy","in":"query","schemaId":"schema_25","description":"Scope the search to one taxonomy. Omit to search all three at once."},{"name":"limit","in":"query","schemaId":"schema_26","description":"Page size (1-500)."},{"name":"offset","in":"query","schemaId":"schema_27","description":"Page offset (0-10000)."},{"name":"naics_leaf_only","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applied when taxonomy=naics. When true, returns only 6-digit leaf codes."},"children":[]}]}]}]}],"pointer":"/paths/~1data-api~1v2~1industries~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/industries/search","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[{"name":"q","in":"query","required":false,"schemaId":"schema_24"},{"name":"taxonomy","in":"query","required":false,"schemaId":"components/schemas/TaxonomyType"},{"name":"limit","in":"query","required":false,"schemaId":"schema_26"},{"name":"offset","in":"query","required":false,"schemaId":"schema_27"},{"name":"naics_leaf_only","in":"query","required":false,"schemaId":"schema_28"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data-api/v2/industries/search","href":"industries/v2_search_industries","openApiOperationId":"v2_search_industries","summary":"Search 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":"Industry search results","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IndustrySearchResponse"}},"schemaId":"components/schemas/IndustrySearchResponse"},{"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~1v2~1industries~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IndustrySearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IndustrySearchResponse"}}},{"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":"/industries/v2_search_industries"}],"panels":[]}]},"httpPath":"/data-api/v2/industries/search"}],"content":{"contentType":"group","meta":{"name":"Industries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Industries","showPageActions":true},{"nodeType":"markdoc","content":"Industry taxonomy search across HG industry, NAICS 2012, and SIC 1987."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v2/industries/search","summary":"Search industries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/industries/v2_search_industries","deprecated":false}]}]}]}]}},{"type":"group","label":"Credits","link":"/v2/openapi/credits","routeSlug":"/v2/openapi/credits","items":[{"label":"Get Credits Balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/credits/get_credits","routeSlug":"/v2/openapi/credits/get_credits","metadata":{"seo":{"title":"Get Credits Balance","description":"Returns credit balance, contract dates, and data entitlements for the authenticated organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_credits","name":"Get Credits Balance","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1credits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Credits Balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns credit balance, contract dates, and data entitlements for the authenticated organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-api/v2/credits","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","401","502"],"pointer":"/data-api/v2/credits","href":"credits/get_credits","openApiOperationId":"get_credits","summary":"Get Credits Balance"},"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":"Credits Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsResponse"}},"schemaId":"components/schemas/CreditsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"502","description":"Upstream Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29"}},"schemaId":"schema_29"}],"pointer":"/paths/~1data-api~1v2~1credits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"502","schemaId":"schema_29","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/get_credits"}],"panels":[]}]},"httpPath":"/data-api/v2/credits"}],"content":{"contentType":"group","meta":{"name":"Credits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credits","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v2/credits","summary":"Get Credits Balance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/get_credits","deprecated":false}]}]}]}]}},{"type":"group","label":"Time Series","link":"/v2/openapi/time-series","routeSlug":"/v2/openapi/time-series","items":[{"label":"Get Technographics Time Series","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/time-series/technographics_time_series","routeSlug":"/v2/openapi/time-series/technographics_time_series","metadata":{"seo":{"title":"Get Technographics Time Series","description":"Returns monthly intensity time series per product for a single company. Dense arrays with null-filled gaps, ready for charting."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"technographics_time_series","name":"Get Technographics Time Series","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1technographics~1time-series/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Technographics Time Series","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns monthly intensity time series per product for a single company. Dense arrays with null-filled gaps, ready for charting."},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TechnographicsTimeSeriesRequest"}},"schemaId":"components/schemas/TechnographicsTimeSeriesRequest","pointer":"/paths/~1data-api~1v2~1technographics~1time-series/post/requestBody","description":"Technographics Time Series Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/technographics/time-series","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TechnographicsTimeSeriesRequest"}},"responseCodes":["200","401","404","422","503"],"pointer":"/data-api/v2/technographics/time-series","href":"time-series/technographics_time_series","openApiOperationId":"technographics_time_series","summary":"Get Technographics Time Series"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/TechnographicsTimeSeriesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TechnographicsTimeSeriesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Technographics Time Series Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TechnographicsTimeSeriesResponse"}},"schemaId":"components/schemas/TechnographicsTimeSeriesResponse"},{"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"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}},"schemaId":"components/schemas/ServiceUnavailableResponse"}],"pointer":"/paths/~1data-api~1v2~1technographics~1time-series/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TechnographicsTimeSeriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TechnographicsTimeSeriesResponse"}}},{"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"}}},{"code":"503","schemaId":"components/schemas/ServiceUnavailableResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/time-series/technographics_time_series"}],"panels":[]}]},"httpPath":"/data-api/v2/technographics/time-series"}],"content":{"contentType":"group","meta":{"name":"Time Series"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Time Series","showPageActions":true},{"nodeType":"markdoc","content":"Monthly intensity time series per product for a single company."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v2/technographics/time-series","summary":"Get Technographics Time Series","prefix":{"name":"post","color":"post"},"badges":[],"link":"/time-series/technographics_time_series","deprecated":false}]}]}]}]}},{"type":"group","label":"Mentions","link":"/v2/openapi/mentions","routeSlug":"/v2/openapi/mentions","items":[{"label":"Mentions time series","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/mentions/v2_mentions_time_series","routeSlug":"/v2/openapi/mentions/v2_mentions_time_series","metadata":{"seo":{"title":"Mentions time series","description":"Single-company mentions time series."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_mentions_time_series","name":"Mentions time series","isWebhook":false,"pointer":"/paths/~1data-api~1v2~1companies~1mentions~1time-series/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mentions time series","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Single-company mentions time series."},{"nodeType":"security","requirements":[{"schemes":[{"name":"authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MentionsTimeSeriesRequest"}},"schemaId":"components/schemas/MentionsTimeSeriesRequest","pointer":"/paths/~1data-api~1v2~1companies~1mentions~1time-series/post/requestBody","description":"Mentions time series parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-api/v2/companies/mentions/time-series","servers":[{"url":"https://api.hginsights.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MentionsTimeSeriesRequest"}},"responseCodes":["200","401","404","422","503"],"pointer":"/data-api/v2/companies/mentions/time-series","href":"mentions/v2_mentions_time_series","openApiOperationId":"v2_mentions_time_series","summary":"Mentions time series"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.hginsights.com"}],"schemaId":"components/schemas/MentionsTimeSeriesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MentionsTimeSeriesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Mentions time series results","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MentionsTimeSeriesResponse"}},"schemaId":"components/schemas/MentionsTimeSeriesResponse"},{"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"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}},"schemaId":"components/schemas/ServiceUnavailableResponse"}],"pointer":"/paths/~1data-api~1v2~1companies~1mentions~1time-series/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MentionsTimeSeriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MentionsTimeSeriesResponse"}}},{"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"}}},{"code":"503","schemaId":"components/schemas/ServiceUnavailableResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUnavailableResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mentions/v2_mentions_time_series"}],"panels":[]}]},"httpPath":"/data-api/v2/companies/mentions/time-series"}],"content":{"contentType":"group","meta":{"name":"Mentions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mentions","showPageActions":true},{"nodeType":"markdoc","content":"Company mentions time series data."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-api/v2/companies/mentions/time-series","summary":"Mentions time series","prefix":{"name":"post","color":"post"},"badges":[],"link":"/mentions/v2_mentions_time_series","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/V2IntentTopic":{"id":"components/schemas/V2IntentTopic","kind":"json-schema","title":"V2IntentTopic","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","category"],"title":"V2IntentTopic","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.IntentTopic","x-validate":null}},"components/schemas/SicMapping":{"id":"components/schemas/SicMapping","kind":"json-schema","title":"SicMapping","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIC 1987 code (HG-extended + standard)."},"children":[]}]}]}],"properties":{"is_hg_extension":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True when sic_code is an HG-extended code (letter-prefixed)."},"children":[]}]}]}],"nullable":true,"type":"boolean","x-struct":null,"x-validate":null},"naics_count":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of distinct NAICS codes mapped to this SIC code. Only set when taxonomy=sic."},"children":[]}]}]}],"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"sic_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HG-extended SIC code with letter prefix (e.g. 'I7372'). Not a standard SIC code — use sic_standard_code for downstream calls."},"children":[]}]}]}],"nullable":true,"type":"string","x-struct":null,"x-validate":null},"sic_name":{"description":"SIC 1987 label.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"sic_standard_code":{"description":"Standard SIC-1987 code (e.g. '7372'). Use this value for downstream endpoints.","nullable":true,"type":"string","x-struct":null,"x-validate":null}},"title":"SicMapping","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Industries.Search.SicMapping","x-validate":null}},"components/schemas/PeerGroup":{"id":"components/schemas/PeerGroup","kind":"json-schema","title":"PeerGroup","data":{"description":"Peer group definition used for benchmarking","properties":{"employee_range":{"description":"Employee count range (e.g. 1000-5000)","nullable":true,"type":"string","x-struct":null,"x-validate":null},"industry":{"description":"Industry classification","nullable":true,"type":"string","x-struct":null,"x-validate":null},"peer_count":{"description":"Number of peers in the group","type":"integer","x-struct":null,"x-validate":null},"region":{"description":"Geographic region","nullable":true,"type":"string","x-struct":null,"x-validate":null}},"title":"PeerGroup","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.MarketBenchmarks.PeerGroup","x-validate":null}},"components/schemas/StatisticsSpendSummary":{"id":"components/schemas/StatisticsSpendSummary","kind":"json-schema","title":"StatisticsSpendSummary","data":{"description":"Summary statistics for a company's IT spend","nullable":true,"properties":{"category_count":{"description":"Number of spend categories","minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"currency":{"description":"Currency code (always USD)","type":"string","x-struct":null,"x-validate":null},"spend_efficiency_score":{"description":"Spend efficiency score (0-100)","maximum":100,"minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"top_category":{"description":"Category with highest spend","nullable":true,"type":"string","x-struct":null,"x-validate":null},"top_category_spend":{"description":"Spend in top category","minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"total_it_spend":{"description":"Total estimated IT spend","nullable":true,"type":"integer","x-struct":null,"x-validate":null},"yoy_growth_rate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Year-over-year spend growth rate (decimal, e.g. 0.15 = 15%)"},"children":[]}]}]}],"format":"float","nullable":true,"type":"number","x-struct":null,"x-validate":null}},"title":"StatisticsSpendSummary","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Statistics.SpendSummary","x-validate":null}},"components/schemas/CompanySearchV2Sorts":{"id":"components/schemas/CompanySearchV2Sorts","kind":"json-schema","title":"CompanySearchV2Sorts","data":{"default":[],"description":"List of sort objects","items":{"$ref":"#/components/schemas/CompanySearchV2Sort"},"title":"CompanySearchV2Sorts","type":"array","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Search.Sorts","x-validate":null}},"components/schemas/V2JobSenioritiesResponse":{"id":"components/schemas/V2JobSenioritiesResponse","kind":"json-schema","title":"V2JobSenioritiesResponse","data":{"description":"Response schema for job seniorities","example":{"count":1,"data":[{"name":"Director"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/V2JobSeniority"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2JobSenioritiesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.JobSenioritiesResponse","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/HierarchyRequest":{"id":"components/schemas/HierarchyRequest","kind":"json-schema","title":"HierarchyRequest","data":{"additionalProperties":false,"description":"Request body for the hierarchy endpoint.","example":{"filters":{"countries":["BR"],"regions":["EMEA"]},"format":"list","hierarchy":{"id":"1698C53EBC888758570396E0334965C1"},"mode":"full","selected_fields":["id","name","domain","company_level"]},"properties":{"filters":{"$ref":"#/components/schemas/HierarchyFilters"},"format":{"default":"tree","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls the response shape: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tree"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (nested) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (flat). Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tree"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tiers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters require "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format: list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; sending any of them"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format: tree"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (including the default when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted) returns HTTP 400"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FILTER_NOT_VALID_FOR_TREE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_tier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter works with both formats and can be used"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to limit tree depth."},"children":[]}]}]}],"enum":["tree","list"],"type":"string","x-struct":null,"x-validate":null},"hierarchy":{"$ref":"#/components/schemas/HierarchyFilter"},"mode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls which part of the corporate hierarchy to return."},"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":"code","inline":true,"attributes":{"content":"full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — returns the entire tree rooted at the Group HQ, regardless of which company was matched. Every node in the corporate family is included."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"children"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — returns a subtree rooted at the matched company, including all of its subsidiaries and their descendants."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — returns only the ancestor chain from the Group HQ down to the matched company (no siblings or cousins)."},"children":[]}]}]}]}],"enum":["full","children","parents"],"type":"string","x-struct":null,"x-validate":null},"selected_fields":{"default":["id","name","domain","domain_normalized","company_level","parent_id"],"description":"Optional field override. When provided, only these fields (plus always-present selected) are returned.","items":{"enum":["id","name","domain","domain_normalized","company_level","global_hq_id","global_hq_name","corporate_parent_id","corporate_parent_name","domestic_parent_id","domestic_parent_name","parent_id","country_code","country_name","city_name","state_name","revenue_total","revenue_band","employees_total","employees_band","industry_name","naics_code","naics_name","sic_codes","sic_names"],"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"sort":{"description":"Optional list of sort directives applied to the hierarchy results.","items":{"$ref":"#/components/schemas/HierarchySort"},"type":"array","x-struct":null,"x-validate":null}},"required":["hierarchy","mode"],"title":"HierarchyRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Hierarchy.Request","x-validate":null}},"components/schemas/TechnologyBenchmarks":{"id":"components/schemas/TechnologyBenchmarks","kind":"json-schema","title":"TechnologyBenchmarks","data":{"description":"Technology stack benchmarks against peer group","properties":{"cloud_adoption_percentile":{"description":"Percentile rank for cloud adoption vs peers","maximum":100,"minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"modern_stack_score":{"description":"Modern stack score vs peers (reserved for future use)","maximum":100,"minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"peer_median_products":{"description":"Median product count among peers","nullable":true,"type":"integer","x-struct":null,"x-validate":null},"security_stack_percentile":{"description":"Percentile rank for security stack vs peers (reserved for future use)","maximum":100,"minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"total_products_percentile":{"description":"Percentile rank for total products vs peers","maximum":100,"minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null}},"title":"TechnologyBenchmarks","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.MarketBenchmarks.TechnologyBenchmarks","x-validate":null}},"components/schemas/DeploymentDistribution":{"id":"components/schemas/DeploymentDistribution","kind":"json-schema","title":"DeploymentDistribution","data":{"description":"Distribution of products by deployment model","properties":{"cloud":{"description":"Number of cloud products","minimum":0,"type":"integer","x-struct":null,"x-validate":null},"cloud_percentage":{"description":"Percentage of cloud products","format":"float","maximum":100,"minimum":0,"nullable":true,"type":"number","x-struct":null,"x-validate":null},"hybrid":{"description":"Number of hybrid products","minimum":0,"type":"integer","x-struct":null,"x-validate":null},"on_premise":{"description":"Number of on-premise products","minimum":0,"type":"integer","x-struct":null,"x-validate":null}},"title":"DeploymentDistribution","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Statistics.DeploymentDistribution","x-validate":null}},"components/schemas/Statistics":{"id":"components/schemas/Statistics","kind":"json-schema","title":"Statistics","data":{"description":"Aggregated statistics for a company across tech stack, spend, contracts, and employees","nullable":true,"properties":{"computed_at":{"description":"When statistics were computed","format":"date","nullable":true,"type":"string","x-struct":null,"x-validate":null},"contract_summary":{"allOf":[{"$ref":"#/components/schemas/StatisticsContractSummary"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null},"employee_summary":{"allOf":[{"$ref":"#/components/schemas/EmployeeSummary"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null},"spend_summary":{"allOf":[{"$ref":"#/components/schemas/StatisticsSpendSummary"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null},"tech_stack_summary":{"allOf":[{"$ref":"#/components/schemas/TechStackSummary"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null}},"title":"Statistics","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Statistics","x-validate":null}},"components/schemas/NumericIdFilter":{"id":"components/schemas/NumericIdFilter","kind":"json-schema","title":"NumericIdFilter","data":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by numeric IDs and/or names (assumes ANY_PRESENT inclusion method)"},"children":[]}]}]}],"properties":{"ids":{"description":"Array of numeric IDs","items":{"type":"integer","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"names":{"description":"Array of entity names for substring matching (case-insensitive)","items":{"minLength":1,"type":"string","x-struct":null,"x-validate":null},"maxItems":10,"type":"array","x-struct":null,"x-validate":null}},"title":"NumericIdFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.TechnographicsFilters.NumericIdFilter","x-validate":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.TechnographicsFilters.NumericIdFilter"}},"components/schemas/VendorFilter":{"id":"components/schemas/VendorFilter","kind":"json-schema","title":"VendorFilter","data":{"description":"Filter based on the associated vendor for an install record, with optional FAI, install age, and product count sub-filters.","example":{"ids":[316],"inclusion_method":"ANY_PRESENT","product_count":{"min":5}},"properties":{"fai":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Functional Area Intelligence filter — at least one of departments or roles required"},"children":[]}]}]}],"minProperties":1,"properties":{"departments":{"$ref":"#/components/schemas/IdInclusionFilter"},"roles":{"$ref":"#/components/schemas/IdInclusionFilter"}},"type":"object","x-struct":null,"x-validate":null},"ids":{"description":"Vendor 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/InclusionMethod"},"install_age":{"$ref":"#/components/schemas/RangeFilter"},"install_age_months":{"$ref":"#/components/schemas/RangeFilter"},"product_count":{"$ref":"#/components/schemas/RangeFilter"}},"required":["ids","inclusion_method"],"title":"VendorFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.Installs.VendorFilter","x-validate":null}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Premium":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Premium","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Premium","data":{"description":"Firmographic premium data for a company","properties":{"company_level":{"type":"string","x-struct":null,"x-validate":null},"corporate_parent_id":{"nullable":true,"type":"string","x-struct":null,"x-validate":null},"corporate_parent_name":{"nullable":true,"type":"string","x-struct":null,"x-validate":null},"domestic_parent_id":{"nullable":true,"type":"string","x-struct":null,"x-validate":null},"domestic_parent_name":{"nullable":true,"type":"string","x-struct":null,"x-validate":null},"global_hq_city_name":{"type":"string","x-struct":null,"x-validate":null},"global_hq_continent_name":{"type":"string","x-struct":null,"x-validate":null},"global_hq_country_code":{"type":"string","x-struct":null,"x-validate":null},"global_hq_country_name":{"type":"string","x-struct":null,"x-validate":null},"global_hq_domain":{"type":"string","x-struct":null,"x-validate":null},"global_hq_domain_normalized":{"type":"string","x-struct":null,"x-validate":null},"global_hq_employees_band":{"type":"string","x-struct":null,"x-validate":null},"global_hq_forbes_2000_rank":{"type":"integer","x-struct":null,"x-validate":null},"global_hq_fortune_500_rank":{"type":"integer","x-struct":null,"x-validate":null},"global_hq_geopolitical_name":{"type":"string","x-struct":null,"x-validate":null},"global_hq_id":{"type":"string","x-struct":null,"x-validate":null},"global_hq_industry_id":{"type":"integer","x-struct":null,"x-validate":null},"global_hq_industry_name":{"type":"string","x-struct":null,"x-validate":null},"global_hq_naics_code":{"type":"string","x-struct":null,"x-validate":null},"global_hq_naics_name":{"type":"string","x-struct":null,"x-validate":null},"global_hq_name":{"type":"string","x-struct":null,"x-validate":null},"global_hq_postal_code":{"type":"string","x-struct":null,"x-validate":null},"global_hq_revenue_band":{"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_sic_names":{"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},"global_hq_subcontinent_name":{"type":"string","x-struct":null,"x-validate":null},"it_spend":{"type":"number","x-struct":null,"x-validate":null},"parent_id":{"nullable":true,"type":"string","x-struct":null,"x-validate":null}},"title":"TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Premium","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Firmographics.Premium","x-validate":null}},"components/schemas/FunctionalAreasFilters":{"id":"components/schemas/FunctionalAreasFilters","kind":"json-schema","title":"FunctionalAreasFilters","data":{"additionalProperties":false,"description":"Optional filters to narrow FAI results.","properties":{"country":{"additionalProperties":false,"description":"Filter by ISO 3166-1 alpha-2 country codes","example":{"codes":["US","CA"]},"properties":{"codes":{"description":"Country codes","items":{"type":"string","x-struct":null,"x-validate":null},"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"required":["codes"],"type":"object","x-struct":null,"x-validate":null},"departments":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by FAI department IDs (from /v2/catalog/fai_departments)"},"children":[]}]}]}],"example":{"ids":["3570470BAD94692CE93E32700D2E1CB"]},"properties":{"ids":{"description":"Department IDs (hex-encoded)","items":{"$ref":"#/components/schemas/HexId"},"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"required":["ids"],"type":"object","x-struct":null,"x-validate":null},"has_decision_maker":{"description":"Filter to rows where a decision maker is present","type":"boolean","x-struct":null,"x-validate":null},"has_influencer":{"description":"Filter to rows where an influencer is present","type":"boolean","x-struct":null,"x-validate":null},"last_verified_date":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only return rows where last_verified_at >= this date (ISO 8601)"},"children":[]}]}]}],"example":"2024-01-01","format":"date","type":"string","x-struct":null,"x-validate":null},"products":{"additionalProperties":false,"description":"Filter by product IDs","example":{"ids":[814,805]},"properties":{"ids":{"description":"Product IDs","items":{"type":"integer","x-struct":null,"x-validate":null},"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"required":["ids"],"type":"object","x-struct":null,"x-validate":null},"roles":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by FAI role IDs (from /v2/catalog/fai_departments)"},"children":[]}]}]}],"example":{"ids":["38823D12CF303C0B30D1AA2E924BDE3"]},"properties":{"ids":{"description":"Role IDs (hex-encoded)","items":{"$ref":"#/components/schemas/HexId"},"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"required":["ids"],"type":"object","x-struct":null,"x-validate":null},"vendors":{"additionalProperties":false,"description":"Filter by vendor IDs","example":{"ids":[311,466]},"properties":{"ids":{"description":"Vendor IDs","items":{"type":"integer","x-struct":null,"x-validate":null},"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"required":["ids"],"type":"object","x-struct":null,"x-validate":null}},"title":"FunctionalAreasFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.FunctionalAreas.Filters","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/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/ContractSearchResponse":{"id":"components/schemas/ContractSearchResponse","kind":"json-schema","title":"ContractSearchResponse","data":{"description":"Paginated list of contracts matching the search criteria.","example":{"count":1,"records":[{"announcement_date":"2025-04-23","bid_process":"Competitive","contract_event":"New","contract_structure":"Single Vendor","customer_drivers":"Business Continuity (Run the Business)","customer_name":"LATVENERGO AS","deal_value":2554421,"end_date":"2030-04-17","id":"2F730FBEB8C74FBB753736C5CF74F5B8","larger_contract":false,"performance_criteria":"Consistent Quality","pricing_structure":"Incentive Contracts","primary_vendor":{"name":"Inavitas"},"service_lines":[{"delivery":"On Premise","geographic_scope":"Latvia","service_types":"Application Management"}],"signing_country":"Latvia","start_date":"2025-04-17","summary":"Inavitas Enerji has been selected by Latvenergo of Latvia for provision of renewable electric energy resource management system implementation and five-year support. The contract was awarded on April 17, 2025 which is worth EUR2.2m ($2.5m).","term":60,"title":"Inavitas Enerji secured an IT service contract from Latvenergo of Latvia"}]},"properties":{"count":{"description":"Total number of contracts matching the filters (before pagination)","type":"integer","x-struct":null,"x-validate":null},"records":{"description":"List of contract records matching the search criteria","items":{"type":"object","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"required":["count","records"],"title":"ContractSearchResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contracts.Search.Response","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/TechnographicsTimeSeriesFilters":{"id":"components/schemas/TechnographicsTimeSeriesFilters","kind":"json-schema","title":"TechnographicsTimeSeriesFilters","data":{"additionalProperties":false,"example":{"vendors":{"ids":[376]}},"properties":{"categories":{"additionalProperties":false,"properties":{"ids":{"items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"country":{"additionalProperties":false,"properties":{"codes":{"description":"ISO 3166-1 alpha-2 country codes to filter by","items":{"maxLength":2,"minLength":2,"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"granularity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\":country\" returns one entry per product per country with country_code populated. \":global\" returns deduplicated entries per product with country_code null. Defaults to \":global\"."},"children":[]}]}]}],"enum":["global","country"],"type":"string","x-struct":null,"x-validate":null},"products":{"additionalProperties":false,"properties":{"ids":{"items":{"type":"integer","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"vendors":{"additionalProperties":false,"properties":{"ids":{"items":{"type":"integer","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null}},"title":"TechnographicsTimeSeriesFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Technographics.TimeSeries.Filters","x-validate":null}},"components/schemas/ContactsEnrichEstimateResponse":{"id":"components/schemas/ContactsEnrichEstimateResponse","kind":"json-schema","title":"ContactsEnrichEstimateResponse","data":{"properties":{"available_credits":{"description":"Remaining credits in cycle","type":"integer","x-struct":null,"x-validate":null},"credits_estimate":{"description":"Max credits that will be consumed","format":"double","type":"number","x-struct":null,"x-validate":null},"details":{"description":"Per-data-type breakdown (only includes requested fields)","properties":{"contact_email":{"$ref":"#/components/schemas/DataTypeEstimateDetail"},"contact_phone":{"$ref":"#/components/schemas/DataTypeEstimateDetail"}},"type":"object","x-struct":null,"x-validate":null},"sufficient_credits":{"description":"Whether org has enough credits","type":"boolean","x-struct":null,"x-validate":null}},"required":["credits_estimate","available_credits","sufficient_credits","details"],"title":"ContactsEnrichEstimateResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contacts.Enrich.EstimateResponse","x-validate":null}},"components/schemas/ProductAttributesFilterCompanyInstalls":{"id":"components/schemas/ProductAttributesFilterCompanyInstalls","kind":"json-schema","title":"ProductAttributesFilterCompanyInstalls","data":{"description":"Filter based on the product attributes associated with an install record, with optional install age sub-filters.","example":{"ids":[222],"inclusion_method":"ANY_PRESENT","install_age_months":{"max":18,"min":3}},"properties":{"ids":{"description":"Product Attribute 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/InclusionMethod"},"install_age":{"$ref":"#/components/schemas/RangeFilter"},"install_age_months":{"$ref":"#/components/schemas/RangeFilter"}},"required":["ids","inclusion_method"],"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/CompaniesSearchResponse":{"id":"components/schemas/CompaniesSearchResponse","kind":"json-schema","title":"CompaniesSearchResponse","data":{"description":"Paginated list of companies matching the search criteria.","example":{"companies":[{"domain":"ford.com","id":"3AE6DA985017C625659E242A074C5A88","name":"Ford Motor Company"}],"count":1},"properties":{"companies":{"items":{"$ref":"#/components/schemas/CompanySearchV2Result"},"type":"array","x-struct":null,"x-validate":null},"count":{"description":"Total number of companies matching the filters (before pagination)","type":"integer","x-struct":null,"x-validate":null}},"required":["companies","count"],"title":"CompaniesSearchResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Search.Response","x-validate":null}},"components/schemas/MentionsTimeSeriesResponse":{"id":"components/schemas/MentionsTimeSeriesResponse","kind":"json-schema","title":"MentionsTimeSeriesResponse","data":{"example":{"company":{"id":"E48EDEB162A5FBFDAF2DCF707079F8F","name":"Walmart Inc."},"mentions":[{"current_intensity":72,"data_points":[{"date":"2024-01","intensity":45},{"date":"2024-02","intensity":null},{"date":"2024-03","intensity":51},{"date":"2024-04","intensity":72}],"is_active":true,"mention_category_name":"Container Orchestration","mention_id":100,"mention_name":"Kubernetes"}],"time_range":{"end":"2025-07","start":"2023-07"}},"properties":{"company":{"type":"object","x-struct":null,"x-validate":null},"mentions":{"items":{"$ref":"#/components/schemas/MentionsTimeSeriesMention"},"type":"array","x-struct":null,"x-validate":null},"time_range":{"type":"object","x-struct":null,"x-validate":null}},"title":"MentionsTimeSeriesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Mentions.TimeSeries.Response","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/SpendBenchmarks":{"id":"components/schemas/SpendBenchmarks","kind":"json-schema","title":"SpendBenchmarks","data":{"description":"IT spend benchmarks against peer group","properties":{"it_spend_percentile":{"description":"Percentile rank for IT spend vs peers","maximum":100,"minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"peer_median_spend":{"description":"Median IT spend among peers","nullable":true,"type":"integer","x-struct":null,"x-validate":null},"spend_per_employee":{"description":"IT spend per employee","nullable":true,"type":"integer","x-struct":null,"x-validate":null},"spend_per_employee_percentile":{"description":"Percentile rank for spend per employee vs peers","maximum":100,"minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"spend_vs_peer_median":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ratio of spend to peer median (e.g. 1.2 = 20% above median)"},"children":[]}]}]}],"format":"float","nullable":true,"type":"number","x-struct":null,"x-validate":null}},"title":"SpendBenchmarks","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.MarketBenchmarks.SpendBenchmarks","x-validate":null}},"components/schemas/CompanySearchV2AiSpendFilter":{"id":"components/schemas/CompanySearchV2AiSpendFilter","kind":"json-schema","title":"CompanySearchV2AiSpendFilter","data":{"additionalProperties":false,"description":"Filter by USD spent by a company in certain AI spend categories.","example":{"categories":{"ids":["3B36D42E7F8E60BE58BA4356B6AF40C"],"inclusion_method":"ANY_PRESENT"},"range":{"min":2000000000}},"minProperties":2,"properties":{"categories":{"$ref":"#/components/schemas/AnyIdInclusionFilter"},"range":{"$ref":"#/components/schemas/CompanySearchV2RangeFilter"}},"required":["categories","range"],"title":"CompanySearchV2AiSpendFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.AiSpendFilter","x-validate":null}},"components/schemas/MatchResult":{"id":"components/schemas/MatchResult","kind":"json-schema","title":"MatchResult","data":{"description":"A single company match result","properties":{"country":{"description":"ISO 3166 alpha-2 country code of the matched company","nullable":true,"type":"string","x-struct":null,"x-validate":null},"domain":{"description":"Company domain","nullable":true,"type":"string","x-struct":null,"x-validate":null},"id":{"description":"HG company ID (hex-encoded)","type":"string","x-struct":null,"x-validate":null},"matched_on":{"description":"Fields that contributed to this match","items":{"enum":["name","domain","country"],"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"name":{"description":"Company name","nullable":true,"type":"string","x-struct":null,"x-validate":null}},"required":["id"],"title":"MatchResult","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Match.MatchResult","x-validate":null}},"components/schemas/FunctionalAreasEstimateResponse":{"id":"components/schemas/FunctionalAreasEstimateResponse","kind":"json-schema","title":"FunctionalAreasEstimateResponse","data":{"description":"Estimated credit cost for a Functional Area Intelligence request.","example":{"available_credits":1000,"credits_estimate":12.5,"sufficient_credits":true},"properties":{"available_credits":{"description":"Credits currently available to the organization","type":"integer","x-struct":null,"x-validate":null},"credits_estimate":{"description":"Estimated credits required to fulfill the request","format":"double","type":"number","x-struct":null,"x-validate":null},"sufficient_credits":{"description":"Whether available credits cover the estimate","type":"boolean","x-struct":null,"x-validate":null}},"required":["credits_estimate","available_credits","sufficient_credits"],"title":"FunctionalAreasEstimateResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.FunctionalAreas.EstimateResponse","x-validate":null}},"components/schemas/IndustrySearchResponse":{"id":"components/schemas/IndustrySearchResponse","kind":"json-schema","title":"IndustrySearchResponse","data":{"description":"Response envelope for GET /v2/industries/search.","properties":{"alias_expansions":{"description":"Populated when one or more q terms were treated as colloquial aliases and expanded server-side.","items":{"$ref":"#/components/schemas/AliasExpansion"},"nullable":true,"type":"array","x-struct":null,"x-validate":null},"pagination":{"$ref":"#/components/schemas/IndustrySearchPagination"},"results":{"description":"Matched industry crosswalk rows.","items":{"$ref":"#/components/schemas/IndustrySearchResult"},"type":"array","x-struct":null,"x-validate":null},"suggestions":{"description":"Populated only when 0 results and q was a text term. Up to 5 closest taxonomy names by trigram distance.","items":{"type":"string","x-struct":null,"x-validate":null},"nullable":true,"type":"array","x-struct":null,"x-validate":null}},"required":["results","pagination"],"title":"IndustrySearchResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Industries.Search.IndustrySearchResponse","x-validate":null}},"components/schemas/FunctionalAreasRequest":{"id":"components/schemas/FunctionalAreasRequest","kind":"json-schema","title":"FunctionalAreasRequest","data":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Functional Area Intelligence for a company. Provide the company by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"company":{"domain":"microsoft.com"},"filters":{"departments":{"ids":["3570470BAD94692CE93E32700D2E1CB"]},"products":{"ids":[814]},"vendors":{"ids":[311,466]}},"limit":100,"offset":0,"sorts":[{"direction":"DESC","field":"department_usage_share"}]},"properties":{"company":{"$ref":"#/components/schemas/FunctionalAreasCompanyFilter"},"filters":{"$ref":"#/components/schemas/FunctionalAreasFilters"},"limit":{"default":100,"description":"Maximum number of records to return","maximum":1000,"minimum":1,"type":"integer","x-struct":null,"x-validate":null},"offset":{"default":0,"description":"Number of records to skip","minimum":0,"type":"integer","x-struct":null,"x-validate":null},"sorts":{"default":[],"description":"Sort order for results","items":{"$ref":"#/components/schemas/FunctionalAreasSort"},"type":"array","x-struct":null,"x-validate":null}},"required":["company"],"title":"FunctionalAreasRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.FunctionalAreas.Request","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/DataTypeEstimateDetail":{"id":"components/schemas/DataTypeEstimateDetail","kind":"json-schema","title":"DataTypeEstimateDetail","data":{"properties":{"credits":{"description":"Credits for this data type","format":"double","type":"number","x-struct":null,"x-validate":null}},"title":"DataTypeEstimateDetail","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.DataTypeDetail","x-validate":null}},"components/schemas/CompanySearchV2RangeFilter":{"id":"components/schemas/CompanySearchV2RangeFilter","kind":"json-schema","title":"CompanySearchV2RangeFilter","data":{"additionalProperties":false,"description":"Range filter object. At least one of min or max is required. When both are provided, min must be less than or equal to max.","example":{"max":100,"min":25},"minProperties":1,"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}},"title":"CompanySearchV2RangeFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.RangeFilter","x-validate":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.RangeFilter"}},"components/schemas/UnauthorizedResponse":{"id":"components/schemas/UnauthorizedResponse","kind":"json-schema","title":"UnauthorizedResponse","data":{"properties":{"errors":{"items":{"properties":{"detail":{"example":"The api key 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.V2.Error.UnauthorizedResponse","x-validate":null}},"components/schemas/HierarchyEstimateResponse":{"id":"components/schemas/HierarchyEstimateResponse","kind":"json-schema","title":"HierarchyEstimateResponse","data":{"description":"Estimated credit cost for a company hierarchy request.","example":{"available_credits":1000,"credits_estimate":110,"sufficient_credits":true},"properties":{"available_credits":{"description":"Credits available in the org's active consumption cycle.","type":"integer","x-struct":null,"x-validate":null},"credits_estimate":{"description":"Estimated number of credits required to fulfill the hierarchy request.","format":"double","type":"number","x-struct":null,"x-validate":null},"sufficient_credits":{"description":"Whether the org has enough credits to cover the estimate.","type":"boolean","x-struct":null,"x-validate":null}},"required":["credits_estimate","available_credits","sufficient_credits"],"title":"HierarchyEstimateResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Hierarchy.EstimateResponse","x-validate":null}},"components/schemas/CreditsResponse":{"id":"components/schemas/CreditsResponse","kind":"json-schema","title":"CreditsResponse","data":{"properties":{"contract_end":{"description":"Contract end date","example":"2024-12-31","type":"string","x-struct":null,"x-validate":null},"contract_start":{"description":"Contract start date","example":"2024-01-01","type":"string","x-struct":null,"x-validate":null},"credits":{"$ref":"#/components/schemas/Credits"},"entitlements":{"$ref":"#/components/schemas/Entitlements"}},"title":"CreditsResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Credits.Response","x-validate":null}},"components/schemas/CompanyInstallsLastVerifiedDateFilter":{"id":"components/schemas/CompanyInstallsLastVerifiedDateFilter","kind":"json-schema","title":"CompanyInstallsLastVerifiedDateFilter","data":{"additionalProperties":false,"description":"Filter by product last verified date range (inclusive)","example":{"max":"2024-12-31","min":"2024-01-01"},"properties":{"max":{"description":"Maximum last verified date (inclusive), e.g. 2024-12-31","format":"date","type":"string","x-struct":null,"x-validate":null},"min":{"description":"Minimum last verified date (inclusive), e.g. 2024-01-01","format":"date","type":"string","x-struct":null,"x-validate":null}},"title":"CompanyInstallsLastVerifiedDateFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.Installs.LastVerifiedDateFilter","x-validate":null}},"components/schemas/MentionsPagination":{"id":"components/schemas/MentionsPagination","kind":"json-schema","title":"MentionsPagination","data":{"additionalProperties":false,"description":"Pagination parameters for mentions data","properties":{"limit":{"$ref":"#/components/schemas/TechnographicsLimit"},"offset":{"$ref":"#/components/schemas/Offset"},"sort":{"$ref":"#/components/schemas/MentionsSort"}},"title":"MentionsPagination","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.MentionsPagination","x-validate":null}},"components/schemas/CompanySearchV2RevenueFilter":{"id":"components/schemas/CompanySearchV2RevenueFilter","kind":"json-schema","title":"CompanySearchV2RevenueFilter","data":{"additionalProperties":false,"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":"CompanySearchV2RevenueFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.RevenueFilter","x-validate":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.RevenueFilter"}},"components/schemas/TechnographicsFilters":{"id":"components/schemas/TechnographicsFilters","kind":"json-schema","title":"TechnographicsFilters","data":{"additionalProperties":false,"description":"Filters for technographics data","example":{"country":{"codes":["US"]},"installs":{"granularity":"country"},"product_attributes":{"ids":[222]},"product_categories":{"ids":["319D067B229178F03BCFA1DA4AC4DEDE"],"names":["CRM"]},"product_last_verified_date":{"max":"2024-12-31","min":"2024-01-01"},"products":{"ids":[814]},"vendors":{"ids":[316],"names":["Salesforce"]}},"properties":{"country":{"$ref":"#/components/schemas/CountryFilter"},"installs":{"$ref":"#/components/schemas/InstallsFilter"},"product_attributes":{"$ref":"#/components/schemas/ProductAttributeFilter"},"product_categories":{"$ref":"#/components/schemas/IdFilter"},"product_last_verified_date":{"$ref":"#/components/schemas/LastVerifiedDateFilter"},"products":{"$ref":"#/components/schemas/NumericIdFilter"},"vendors":{"$ref":"#/components/schemas/NumericIdFilter"}},"title":"TechnographicsFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.TechnographicsFilters","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/AnyNoneIdInclusionFilter"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of hex encoded company identifiers to filter your results by."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ANY_PRESENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return companies matching one of the provided identifiers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NONE_PRESENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to exclude the provided identifiers from your results — useful for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whitespace analysis, where you exclude companies already known to you (e.g. existing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRM/pipeline accounts) and return only net-new companies matching the rest of your filters."},"children":[]}]}]}],"example":{"ids":["1C4B141E475CD272E44F67087E0FDFD4"],"inclusion_method":"NONE_PRESENT"},"type":"object","x-struct":null,"x-validate":null},"company_ids_including_corporate_relatives":{"allOf":[{"$ref":"#/components/schemas/AnyNoneIdInclusionFilter"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of hex encoded company identifiers to filter your results by."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ANY_PRESENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", results include both the companies which match the provided IDs, as well as all other companies within its corporate hierarchy."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NONE_PRESENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the matching companies and their entire corporate hierarchies are excluded from your results — useful for whitespace analysis at the corporate family level."},"children":[]}]}]}],"example":{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"NONE_PRESENT"},"type":"object","x-struct":null,"x-validate":null},"domains":{"allOf":[{"$ref":"#/components/schemas/AnyNoneNameInclusionFilter"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of company domains to filter your results by."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ANY_PRESENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return companies matching one of the provided domains."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NONE_PRESENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to exclude companies with the provided domains from your results."},"children":[]}]}]}],"example":{"ids":["ford.com","google.com"],"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/TalariaWeb.Schemas.V2.Companies.Enrich.Spend.Full":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Spend.Full","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Spend.Full","data":{"allOf":[{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Spend.Premium"}],"description":"Full spend data for a company","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Spend.Full","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Spend.Full","x-validate":null}},"components/schemas/VendorConcentration":{"id":"components/schemas/VendorConcentration","kind":"json-schema","title":"VendorConcentration","data":{"description":"Vendor concentration metrics","properties":{"concentration_level":{"description":"Overall concentration level","enum":["high","medium","low"],"nullable":true,"type":"string","x-struct":null,"x-validate":null},"top_5_vendors_percentage":{"description":"Percentage of products from top 5 vendors","format":"float","maximum":100,"minimum":0,"nullable":true,"type":"number","x-struct":null,"x-validate":null},"top_vendor":{"description":"Top vendor by product count","nullable":true,"type":"string","x-struct":null,"x-validate":null},"top_vendor_product_count":{"description":"Product count for top vendor","minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null}},"title":"VendorConcentration","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Statistics.VendorConcentration","x-validate":null}},"components/schemas/FunctionalAreasCompany":{"id":"components/schemas/FunctionalAreasCompany","kind":"json-schema","title":"FunctionalAreasCompany","data":{"additionalProperties":false,"description":"Company information extracted from FAI data.","nullable":true,"properties":{"domain":{"description":"Company domain","nullable":true,"type":"string","x-struct":null,"x-validate":null},"id":{"description":"HG company ID (hex-encoded)","example":"1698C53EBC888758570396E0334965C1","type":"string","x-struct":null,"x-validate":null},"name":{"description":"Company name","nullable":true,"type":"string","x-struct":null,"x-validate":null}},"title":"FunctionalAreasCompany","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.FunctionalAreas.Company","x-validate":null}},"components/schemas/IntentResponse":{"id":"components/schemas/IntentResponse","kind":"json-schema","title":"IntentResponse","data":{"description":"Intent signals for a single company, combining HG topics and TrustRadius activities.","example":{"activities":{"count":3,"data":[{"activity_date":"2025-06-10","activity_label":"Compare CRMs","activity_type":"PAGE_VIEW","daily_views":3,"intent_signal_url":"https://trustradius.com/x","products":["Salesforce CRM"],"vendors":["Salesforce"]}]},"company":{"domain":"microsoft.com","id":"1698C53EBC888758570396E0334965C1","name":"Microsoft"},"summary":{"active_topics_count":5,"high_signal_topics_count":2,"latest_signal_date":"2025-06-15","sources":{"hg":5,"trustradius":3},"top_context_types":{"Displacement":3,"Whitespace":1}},"topics":{"count":5,"data":[{"buyers_journey_name":"Evaluating","context_dispositions":["POSITIVE"],"context_type_names":["Displacement"],"id":"T1","last_seen_at":"2025-06-15","name":"Cloud Computing","product_names":["EC2"],"score":90,"signal_level":"HIGH","source":"hg","trend":1.2,"vendor_names":["AWS"]}]}},"properties":{"activities":{"allOf":[{"$ref":"#/components/schemas/IntentActivitiesSection"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null},"company":{"$ref":"#/components/schemas/IntentCompany"},"summary":{"allOf":[{"$ref":"#/components/schemas/IntentSummary"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null},"topics":{"allOf":[{"$ref":"#/components/schemas/IntentTopicsSection"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null}},"required":["company"],"title":"IntentResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.Response","x-validate":null}},"components/schemas/FunctionalAreasResponse":{"id":"components/schemas/FunctionalAreasResponse","kind":"json-schema","title":"FunctionalAreasResponse","data":{"description":"FAI response with company info, total count, and data records.","example":{"company":{"domain":"microsoft.com","id":"1698C53EBC888758570396E0334965C1","name":"Microsoft"},"count":42,"data":[{"country_name":"United States","department_id":"3570470BAD94692CE93E32700D2E1CB","department_name":"Engineering","department_signal_strength":12,"department_usage_share":0.45,"has_decision_maker":true,"has_influencer":false,"product_id":814,"product_name":"Oracle Java","role_name":"Software Engineer","vendor_id":311,"vendor_name":"Oracle"}]},"properties":{"company":{"$ref":"#/components/schemas/FunctionalAreasCompany"},"count":{"description":"Total number of matching records (before pagination)","type":"integer","x-struct":null,"x-validate":null},"data":{"description":"FAI data records","items":{"$ref":"#/components/schemas/FunctionalArea"},"type":"array","x-struct":null,"x-validate":null}},"required":["count","data"],"title":"FunctionalAreasResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.FunctionalAreas.Response","x-validate":null}},"components/schemas/ContractsSubBody":{"id":"components/schemas/ContractsSubBody","kind":"json-schema","title":"ContractsSubBody","data":{"additionalProperties":false,"description":"Configuration for contracts data in enrich request","properties":{"filters":{"additionalProperties":false,"description":"Filters for contracts data","properties":{"active_only":{"default":false,"description":"When true, return only active contracts","type":"boolean","x-struct":null,"x-validate":null},"vendor_names":{"description":"Filter by vendor names (max 10)","items":{"type":"string","x-struct":null,"x-validate":null},"maxItems":10,"type":"array","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"limit":{"default":10,"description":"Maximum number of contracts per company","maximum":100,"minimum":1,"type":"integer","x-struct":null,"x-validate":null},"offset":{"default":0,"description":"Number of contracts to skip","minimum":0,"type":"integer","x-struct":null,"x-validate":null}},"title":"ContractsSubBody","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.ContractsSubBody","x-validate":null}},"components/schemas/CompaniesMatchRequest":{"id":"components/schemas/CompaniesMatchRequest","kind":"json-schema","title":"CompaniesMatchRequest","data":{"additionalProperties":false,"description":"Batch match up to 10 companies by name, domain, and/or country","example":{"companies":[{"country":"US","domain":"ford.com","name":"Ford Motor Company"},{"domain":"google.com"}],"limit":3},"properties":{"companies":{"description":"Array of companies to match (1-10)","items":{"$ref":"#/components/schemas/MatchCompanyInput"},"maxItems":10,"minItems":1,"type":"array","x-struct":null,"x-validate":null},"limit":{"default":1,"description":"Maximum number of matches to return per company","maximum":10,"minimum":1,"type":"integer","x-struct":null,"x-validate":null}},"required":["companies"],"title":"CompaniesMatchRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Match.Request","x-validate":null}},"components/schemas/V2SICUS1987":{"id":"components/schemas/V2SICUS1987","kind":"json-schema","title":"V2SICUS1987","data":{"description":"SIC US 1987 schema","example":{"code":"33636","code_standard":"5912","id":"3FCEDF144BE9F3DFF1145DB6C515FB34","name":"Foo Bar","parent_id":"264DD858DB942CAD06F24FF25DF56716"},"properties":{"code":{"description":"SIC US 1987 code","type":"string","x-struct":null,"x-validate":null},"code_standard":{"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},"parent_id":{"description":"Parent SIC US 1987 ID","type":"string","x-struct":null,"x-validate":null}},"required":["code","id","name","parent_id","code_standard"],"title":"V2SICUS1987","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.SicUS1987","x-validate":null}},"components/schemas/HierarchyFilter":{"id":"components/schemas/HierarchyFilter","kind":"json-schema","title":"HierarchyFilter","data":{"additionalProperties":false,"description":"Identifies a company by ID or domain (mutually exclusive).","properties":{"domain":{"description":"Company domain (e.g., example.com)","type":"string","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/HexId"}},"title":"HierarchyFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Hierarchy.HierarchyFilter","x-validate":"Elixir.TalariaWeb.Schemas.V2.Companies.Hierarchy.HierarchyFilter"}},"components/schemas/CompanySearchV2FieldNames":{"id":"components/schemas/CompanySearchV2FieldNames","kind":"json-schema","title":"CompanySearchV2FieldNames","data":{"description":"Allowed fields to be selected and returned in the response.","enum":["id","name","domain","domain_normalized"],"title":"CompanySearchV2FieldNames","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Search.FieldNames","x-validate":null}},"components/schemas/LastVerifiedDateFilter":{"id":"components/schemas/LastVerifiedDateFilter","kind":"json-schema","title":"LastVerifiedDateFilter","data":{"additionalProperties":false,"description":"Filter by product last verified date range (inclusive)","properties":{"max":{"description":"Maximum last verified date (inclusive), e.g. 2024-12-31","format":"date","type":"string","x-struct":null,"x-validate":null},"min":{"description":"Minimum last verified date (inclusive), e.g. 2024-01-01","format":"date","type":"string","x-struct":null,"x-validate":null}},"title":"LastVerifiedDateFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.TechnographicsFilters.LastVerifiedDateFilter","x-validate":null}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Spend":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Spend","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Spend","data":{"allOf":[{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Spend.Full"}],"description":"Spend data for a company","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Spend","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Spend","x-validate":null}},"components/schemas/ContractSearchV2SortDirection":{"id":"components/schemas/ContractSearchV2SortDirection","kind":"json-schema","title":"ContractSearchV2SortDirection","data":{"default":"ASC","description":"Sort direction","enum":["ASC","DESC"],"title":"ContractSearchV2SortDirection","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contracts.Search.SortDirection","x-validate":null}},"components/schemas/CategoryDistribution":{"id":"components/schemas/CategoryDistribution","kind":"json-schema","title":"CategoryDistribution","data":{"description":"Product count distribution by category","properties":{"category_name":{"description":"Category name","type":"string","x-struct":null,"x-validate":null},"percentage":{"description":"Percentage of total products","format":"float","maximum":100,"minimum":0,"nullable":true,"type":"number","x-struct":null,"x-validate":null},"product_count":{"description":"Number of products in this category","minimum":0,"type":"integer","x-struct":null,"x-validate":null}},"required":["category_name","product_count"],"title":"CategoryDistribution","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Statistics.CategoryDistribution","x-validate":null}},"components/schemas/IdInclusionFilter":{"id":"components/schemas/IdInclusionFilter","kind":"json-schema","title":"IdInclusionFilter","data":{"description":"Inclusion filter object for use with hex encoded IDs","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/InclusionMethod"}},"required":["ids","inclusion_method"],"title":"IdInclusionFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.IdInclusionFilter","x-validate":null}},"components/schemas/V2IntentContextType":{"id":"components/schemas/V2IntentContextType","kind":"json-schema","title":"V2IntentContextType","data":{"description":"Intent Context Type 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":"V2IntentContextType","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.IntentContextType","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/V2JobFunctionsResponse":{"id":"components/schemas/V2JobFunctionsResponse","kind":"json-schema","title":"V2JobFunctionsResponse","data":{"description":"Response schema for job functions","example":{"count":1,"data":[{"name":"Engineering"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/V2JobFunction"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2JobFunctionsResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.JobFunctionsResponse","x-validate":null}},"components/schemas/AiSpendFilters":{"id":"components/schemas/AiSpendFilters","kind":"json-schema","title":"AiSpendFilters","data":{"additionalProperties":false,"description":"Filters for AI spend data","example":{"categories":{"ids":["32144E4D868532F1D3A1264DE832ED2F"],"names":["AI Hardware"]}},"properties":{"categories":{"$ref":"#/components/schemas/IdFilter"}},"title":"AiSpendFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.AiSpendFilters","x-validate":null}},"components/schemas/MatchCompanyInput":{"id":"components/schemas/MatchCompanyInput","kind":"json-schema","title":"MatchCompanyInput","data":{"additionalProperties":false,"description":"A company to match. Requires at least one of: name, domain, country.","properties":{"country":{"description":"Country name or ISO 3166 alpha-2 code (e.g., US or United States)","type":"string","x-struct":null,"x-validate":null},"customer_id":{"description":"Optional caller-provided identifier echoed back in the response for correlation","nullable":true,"type":"string","x-struct":null,"x-validate":null},"domain":{"description":"Company domain (e.g., ford.com)","type":"string","x-struct":null,"x-validate":null},"name":{"description":"Company name","type":"string","x-struct":null,"x-validate":null}},"title":"MatchCompanyInput","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Match.CompanyInput","x-validate":"Elixir.TalariaWeb.Schemas.V2.Companies.Match.CompanyInput"}},"components/schemas/V2Country":{"id":"components/schemas/V2Country","kind":"json-schema","title":"V2Country","data":{"description":"Country schema","example":{"code":"FR","id":"6FA567B72D78B7E3EA746973FBBD1D5","name":"France","region":{"id":"22F89A300F983190022374848C4353B0","name":"EMEA"}},"properties":{"code":{"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":["code","id","name","region"],"title":"V2Country","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.Country","x-validate":null}},"components/schemas/SimilarOrganization":{"id":"components/schemas/SimilarOrganization","kind":"json-schema","title":"SimilarOrganization","data":{"description":"An organization similar to the queried company","properties":{"location_country":{"description":"Country of the organization","nullable":true,"type":"string","x-struct":null,"x-validate":null},"organization_id":{"description":"HG organization ID","type":"string","x-struct":null,"x-validate":null},"organization_name":{"description":"Organization name","type":"string","x-struct":null,"x-validate":null},"similarity_factors":{"description":"Factors contributing to similarity","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"similarity_score":{"description":"Similarity score (0.0 to 1.0)","maximum":1,"minimum":0,"type":"number","x-struct":null,"x-validate":null}},"required":["organization_id","organization_name","similarity_score","similarity_factors"],"title":"SimilarOrganization","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.MarketBenchmarks.SimilarOrganization","x-validate":null}},"components/schemas/V2IndustriesResponse":{"id":"components/schemas/V2IndustriesResponse","kind":"json-schema","title":"V2IndustriesResponse","data":{"description":"Response schema for industries","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/V2Industry"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2IndustriesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.IndustriesResponse","x-validate":null}},"components/schemas/V2SpendCategoriesResponse":{"id":"components/schemas/V2SpendCategoriesResponse","kind":"json-schema","title":"V2SpendCategoriesResponse","data":{"description":"Response schema for spend categories","example":{"count":1,"data":[{"export_name":"export_foo_bar","id":"5D8B4B61BA2C56471268612D83903B6","name":"Application Led Outsourcing","name_tree":["Total IT","Total External IT","Services","Application Led Outsourcing"],"parent_id":"1DF1C16E82351BD6ABC74D230191CD1E"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/V2SpendCategory"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2SpendCategoriesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.SpendCategoriesResponse","x-validate":null}},"components/schemas/V2FAIRole":{"id":"components/schemas/V2FAIRole","kind":"json-schema","title":"V2FAIRole","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":"V2FAIRole","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.FaiRole","x-validate":null}},"components/schemas/IntentActivity":{"id":"components/schemas/IntentActivity","kind":"json-schema","title":"IntentActivity","data":{"description":"A TrustRadius buyer intent activity.","properties":{"activity_date":{"description":"Activity date","format":"date","type":"string","x-struct":null,"x-validate":null},"activity_label":{"description":"Activity label","nullable":true,"type":"string","x-struct":null,"x-validate":null},"activity_type":{"description":"Activity type","type":"string","x-struct":null,"x-validate":null},"city_name":{"description":"Visitor city name","nullable":true,"type":"string","x-struct":null,"x-validate":null},"country_name":{"description":"Visitor country name","nullable":true,"type":"string","x-struct":null,"x-validate":null},"daily_views":{"description":"Daily views","nullable":true,"type":"integer","x-struct":null,"x-validate":null},"intent_signal_url":{"description":"Intent signal URL","nullable":true,"type":"string","x-struct":null,"x-validate":null},"products":{"description":"Product names referenced by the activity","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"state_name":{"description":"Visitor state or province name","nullable":true,"type":"string","x-struct":null,"x-validate":null},"vendors":{"description":"Vendor names referenced by the activity","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"title":"IntentActivity","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.ActivityItem","x-validate":null}},"components/schemas/FunctionalAreasSortDirection":{"id":"components/schemas/FunctionalAreasSortDirection","kind":"json-schema","title":"FunctionalAreasSortDirection","data":{"default":"DESC","description":"Sort direction","enum":["ASC","DESC"],"title":"FunctionalAreasSortDirection","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.FunctionalAreas.SortDirection","x-validate":null}},"components/schemas/CompanySearchV2AiMaturityFilter":{"id":"components/schemas/CompanySearchV2AiMaturityFilter","kind":"json-schema","title":"CompanySearchV2AiMaturityFilter","data":{"additionalProperties":false,"description":"Filter by AI maturity data fields.","properties":{"ai_maturity_6m_delta":{"$ref":"#/components/schemas/CompanySearchV2RangeFilter"},"ai_maturity_rank":{"$ref":"#/components/schemas/CompanySearchV2RangeFilter"},"ai_maturity_score":{"$ref":"#/components/schemas/CompanySearchV2RangeFilter"},"ai_product_use":{"description":"Whether company has AI product installed","type":"boolean","x-struct":null,"x-validate":null},"data_maturity_level":{"description":"Filter by data maturity level","items":{"enum":["LOW","MEDIUM","HIGH"],"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"dominant_cloud_provider":{"description":"Filter by dominant cloud provider","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"genai_intent_score":{"$ref":"#/components/schemas/CompanySearchV2RangeFilter"}},"title":"CompanySearchV2AiMaturityFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.AiMaturityFilter","x-validate":null}},"components/schemas/V2FAIDepartmentsResponse":{"id":"components/schemas/V2FAIDepartmentsResponse","kind":"json-schema","title":"V2FAIDepartmentsResponse","data":{"description":"Response schema for FAI departments","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/V2FAIDepartment"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2FAIDepartmentsResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.FaiDepartmentsResponse","x-validate":null}},"components/schemas/ContractSearchV2Filters":{"id":"components/schemas/ContractSearchV2Filters","kind":"json-schema","title":"ContractSearchV2Filters","data":{"additionalProperties":false,"description":"Filters for contract search.","properties":{"active_only":{"description":"When true, return only active contracts","type":"boolean","x-struct":null,"x-validate":null},"active_status":{"description":"Filter by active status (e.g., 'Active', 'Expired')","type":"string","x-struct":null,"x-validate":null},"announcement_date":{"$ref":"#/components/schemas/ContractSearchV2DateRange"},"category_names":{"description":"Filter by category names (max 10)","items":{"type":"string","x-struct":null,"x-validate":null},"maxItems":10,"type":"array","x-struct":null,"x-validate":null},"company_ids":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of HG company IDs (1–1000). Use a single-element list to search one company."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/HexId"},"maxItems":1000,"minItems":1,"type":"array","x-struct":null,"x-validate":null},"deal_value_range":{"$ref":"#/components/schemas/ContractSearchV2DealValueRange"},"end_date":{"$ref":"#/components/schemas/ContractSearchV2DateRange"},"signing_country_names":{"description":"Filter by signing country names (max 10)","items":{"type":"string","x-struct":null,"x-validate":null},"maxItems":10,"type":"array","x-struct":null,"x-validate":null},"start_date":{"$ref":"#/components/schemas/ContractSearchV2DateRange"},"vendor_hg_ids":{"description":"Filter by vendor HG IDs","items":{"$ref":"#/components/schemas/HexId"},"type":"array","x-struct":null,"x-validate":null},"vendor_names":{"description":"Filter by vendor names (max 10)","items":{"type":"string","x-struct":null,"x-validate":null},"maxItems":10,"type":"array","x-struct":null,"x-validate":null}},"title":"ContractSearchV2Filters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contracts.Search.Filters","x-validate":null}},"components/schemas/IntentFilters":{"id":"components/schemas/IntentFilters","kind":"json-schema","title":"IntentFilters","data":{"additionalProperties":false,"description":"Optional filters to narrow intent results.","example":{"activities":{"product_category_ids":["27B2ABE74F4C890C51B3552F493C59"]},"signal_date":{"max":"2026-12-31","min":"2023-01-01"},"topics":{"buyers_journey_names":["Evaluating"],"context_type_names":["Displacement"],"signal_level":["HIGH"]},"vendor_ids":[311]},"properties":{"activities":{"$ref":"#/components/schemas/IntentActivitiesFilters"},"product_ids":{"description":"Filter by product IDs","example":[814,805],"items":{"type":"integer","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"signal_date":{"$ref":"#/components/schemas/SignalDateFilter"},"topics":{"$ref":"#/components/schemas/IntentTopicsFilters"},"vendor_ids":{"description":"Filter by vendor IDs","example":[311,466],"items":{"type":"integer","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"title":"IntentFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.Filters","x-validate":null}},"components/schemas/TimeSeriesRange":{"id":"components/schemas/TimeSeriesRange","kind":"json-schema","title":"TimeSeriesRange","data":{"additionalProperties":false,"properties":{"end_date":{"format":"date","type":"string","x-struct":null,"x-validate":null},"relative_range":{"default":"last_24m","enum":["last_6m","last_12m","last_24m","last_36m"],"type":"string","x-struct":null,"x-validate":null},"start_date":{"format":"date","type":"string","x-struct":null,"x-validate":null}},"title":"TimeSeriesRange","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.TimeSeriesRange","x-validate":"Elixir.TalariaWeb.Schemas.V2.TimeSeriesRange"}},"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/CompanySearchV2Result":{"id":"components/schemas/CompanySearchV2Result","kind":"json-schema","title":"CompanySearchV2Result","data":{"description":"A company returned from search","properties":{"domain":{"description":"Company domain","nullable":true,"type":"string","x-struct":null,"x-validate":null},"domain_normalized":{"description":"Normalized company domain","nullable":true,"type":"string","x-struct":null,"x-validate":null},"id":{"description":"HG company ID (hex-encoded)","type":"string","x-struct":null,"x-validate":null},"name":{"description":"Company name","nullable":true,"type":"string","x-struct":null,"x-validate":null}},"title":"CompanySearchV2Result","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Search.CompanyResult","x-validate":null}},"components/schemas/TechnographicsTimeSeriesDataPoint":{"id":"components/schemas/TechnographicsTimeSeriesDataPoint","kind":"json-schema","title":"TechnographicsTimeSeriesDataPoint","data":{"example":{"date":"2024-01","intensity":72},"properties":{"date":{"description":"YYYY-MM","type":"string","x-struct":null,"x-validate":null},"intensity":{"nullable":true,"type":"integer","x-struct":null,"x-validate":null}},"title":"TechnographicsTimeSeriesDataPoint","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Technographics.TimeSeries.DataPoint","x-validate":null}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.CloudMaturity":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.CloudMaturity","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.CloudMaturity","data":{"allOf":[{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.CloudMaturity.Full"}],"description":"Cloud maturity data for a company","title":"TalariaWeb.Schemas.V2.Companies.Enrich.CloudMaturity","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.CloudMaturity","x-validate":null}},"components/schemas/V2ProductAttribute":{"id":"components/schemas/V2ProductAttribute","kind":"json-schema","title":"V2ProductAttribute","data":{"description":"Product Attribute schema","example":{"children_attributes":[{"description":"Cloud APM software","id":2,"level":2,"name":"Cloud Application Performance Management"}],"description":"Cloud Computing","id":1,"level":1,"name":"Cloud Computing"},"properties":{"children_attributes":{"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":["children_attributes","description","id","level","name"],"title":"V2ProductAttribute","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.ProductAttribute","x-validate":null}},"components/schemas/GlobalSettings":{"id":"components/schemas/GlobalSettings","kind":"json-schema","title":"GlobalSettings","data":{"additionalProperties":false,"default":{"hex_encode_ids":true,"install_recency":36,"localize_installs":true},"description":"GlobalSettings object","example":{"hex_encode_ids":true,"install_recency":12,"localize_installs":false},"properties":{"hex_encode_ids":{"default":true,"description":"Whether to hex encode IDs in the request body","type":"boolean","x-struct":null,"x-validate":null},"install_recency":{"default":36,"description":"Months of product install lookback","type":"integer","x-struct":null,"x-validate":null},"localize_installs":{"default":true,"description":"Only match records where installs are within the same country as the company","type":"boolean","x-struct":null,"x-validate":null},"org_id":{"description":"Organization ID","nullable":true,"type":"string","x-struct":null,"x-validate":null}},"title":"GlobalSettings","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.GlobalSettings","x-validate":null}},"components/schemas/FieldGroups":{"id":"components/schemas/FieldGroups","kind":"json-schema","title":"FieldGroups","data":{"description":"Data categories to include in the response","enum":["firmographics","spend","ai_spend","technographics","contracts","ai_maturity","cloud_maturity","mentions","statistics","market_benchmarks"],"title":"FieldGroups","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.FieldGroups","x-validate":null}},"components/schemas/HierarchySort":{"id":"components/schemas/HierarchySort","kind":"json-schema","title":"HierarchySort","data":{"additionalProperties":false,"description":"Sort directive applied to the hierarchy results.","properties":{"field":{"description":"Field to sort by.","enum":["revenue_total","employees_total","name"],"type":"string","x-struct":null,"x-validate":null},"nulls":{"description":"Where to place null values.","enum":["first","last"],"type":"string","x-struct":null,"x-validate":null},"order":{"description":"Sort order.","enum":["asc","desc"],"type":"string","x-struct":null,"x-validate":null}},"required":["field"],"title":"HierarchySort","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Hierarchy.Sort","x-validate":null}},"components/schemas/V2ProductsResponse":{"id":"components/schemas/V2ProductsResponse","kind":"json-schema","title":"V2ProductsResponse","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/V2Product"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2ProductsResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.ProductsResponse","x-validate":null}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Full":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Full","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Full","data":{"allOf":[{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Basic"},{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Premium"}],"description":"Full firmographic data for a company","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Full","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Firmographics.Full","x-validate":null}},"components/schemas/ContactSearchV2CompaniesFilter":{"id":"components/schemas/ContactSearchV2CompaniesFilter","kind":"json-schema","title":"ContactSearchV2CompaniesFilter","data":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter contacts by company. Provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but not both."},"children":[]}]}]}],"example":{"ids":["1698C53EBC888758570396E0334965C1"]},"properties":{"domains":{"description":"List of company domains.","items":{"type":"string","x-struct":null,"x-validate":null},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"ids":{"description":"List of hex-encoded HG company IDs.","items":{"$ref":"#/components/schemas/HexId"},"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"title":"ContactSearchV2CompaniesFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contacts.Search.CompaniesFilter","x-validate":"Elixir.TalariaWeb.Schemas.V2.Contacts.Search.CompaniesFilter"}},"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/HexId":{"id":"components/schemas/HexId","kind":"json-schema","title":"HexId","data":{"description":"Hexadecimal identifier (unsigned 128-bit base 16 integer)","example":"1698C53EBC888758570396E0334965C1","title":"HexId","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V2.Id","x-validate":"Elixir.TalariaWeb.Schemas.V2.Id"}},"components/schemas/MentionsFilters":{"id":"components/schemas/MentionsFilters","kind":"json-schema","title":"MentionsFilters","data":{"additionalProperties":false,"description":"Filters for mentions data","example":{"granularity":"global","mention_categories":{"ids":["SW036"]},"mentions":{"ids":[24290]}},"properties":{"country":{"$ref":"#/components/schemas/CountryFilter"},"granularity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls the shape of returned mentions. \"country\" returns one row per mention per country. \"global\" returns deduplicated rows per mention with country_code null."},"children":[]}]}]}],"enum":["global","country"],"type":"string","x-struct":null,"x-validate":null},"localized":{"default":true,"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"granularity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"granularity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, it takes precedence."},"children":[]}]}]}],"type":"boolean","x-struct":null,"x-validate":null},"mention_attributes":{"$ref":"#/components/schemas/NumericIdFilter"},"mention_categories":{"$ref":"#/components/schemas/StringIdFilter"},"mention_last_verified_date":{"$ref":"#/components/schemas/LastVerifiedDateFilter"},"mentions":{"$ref":"#/components/schemas/NumericIdFilter"}},"title":"MentionsFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.MentionsFilters","x-validate":null}},"components/schemas/TaxonomyType":{"id":"components/schemas/TaxonomyType","kind":"json-schema","title":"TaxonomyType","data":{"description":"Which taxonomy a search hit matched on.","enum":["industry","naics","sic"],"title":"TaxonomyType","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V2.Industries.Search.TaxonomyType","x-validate":null}},"components/schemas/CompanyEntitlements":{"id":"components/schemas/CompanyEntitlements","kind":"json-schema","title":"CompanyEntitlements","data":{"properties":{"fai":{"description":"Access level for Functional Area Intelligence data","enum":["none","full"],"nullable":true,"type":"string","x-struct":null,"x-validate":null},"firmographics":{"description":"Access level for firmographic data","example":"full","type":"string","x-struct":null,"x-validate":null},"intent":{"description":"Access level for intent data","enum":["none","full"],"nullable":true,"type":"string","x-struct":null,"x-validate":null},"spend":{"description":"Access level for spend data","example":"full","type":"string","x-struct":null,"x-validate":null},"technographics":{"description":"Access level for technographic data","example":"full","type":"string","x-struct":null,"x-validate":null}},"title":"CompanyEntitlements","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Credits.CompanyEntitlements","x-validate":null}},"components/schemas/IntentRequest":{"id":"components/schemas/IntentRequest","kind":"json-schema","title":"IntentRequest","data":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve intent signals (HG topics + TrustRadius activities) for a known company. Provide the company by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"company":{"domain":"microsoft.com"},"fields":["summary","topics","activities"],"filters":{"signal_date":{"max":"2026-12-31","min":"2023-01-01"},"topics":{"signal_level":["HIGH"]},"vendor_ids":[311]},"limit":50,"offset":0},"properties":{"company":{"$ref":"#/components/schemas/CompanyFilter"},"fields":{"default":["summary","topics","activities"],"description":"Which response sections to include.","items":{"enum":["summary","topics","activities"],"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"filters":{"$ref":"#/components/schemas/IntentFilters"},"limit":{"default":50,"description":"Maximum number of records per section","maximum":200,"minimum":1,"type":"integer","x-struct":null,"x-validate":null},"offset":{"default":0,"description":"Number of records to skip per section","minimum":0,"type":"integer","x-struct":null,"x-validate":null}},"required":["company"],"title":"IntentRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.Request","x-validate":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.Request"}},"components/schemas/ContractSearchEstimateRequest":{"id":"components/schemas/ContractSearchEstimateRequest","kind":"json-schema","title":"ContractSearchEstimateRequest","data":{"additionalProperties":false,"description":"Estimate credit cost for a contract search. Only filters are required.","example":{"filters":{"company_ids":["1698C53EBC888758570396E0334965C1"]}},"properties":{"filters":{"$ref":"#/components/schemas/ContractSearchV2Filters"}},"required":["filters"],"title":"ContractSearchEstimateRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contracts.Search.EstimateRequest","x-validate":null}},"components/schemas/ProductFilter":{"id":"components/schemas/ProductFilter","kind":"json-schema","title":"ProductFilter","data":{"description":"Filter based on the associated products for an install record, with optional FAI, install age, and intensity sub-filters.","example":{"fai":{"departments":{"ids":["A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"],"inclusion_method":"ANY_PRESENT"}},"ids":[814],"inclusion_method":"ANY_PRESENT","install_age":{"max":24,"min":6}},"properties":{"fai":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Functional Area Intelligence filter — at least one of departments or roles required"},"children":[]}]}]}],"minProperties":1,"properties":{"departments":{"$ref":"#/components/schemas/IdInclusionFilter"},"roles":{"$ref":"#/components/schemas/IdInclusionFilter"}},"type":"object","x-struct":null,"x-validate":null},"ids":{"description":"Product 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/InclusionMethod"},"install_age":{"$ref":"#/components/schemas/RangeFilter"},"install_age_months":{"$ref":"#/components/schemas/RangeFilter"},"intensity":{"$ref":"#/components/schemas/RangeFilter"}},"required":["ids","inclusion_method"],"title":"ProductFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.Installs.ProductFilter","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.V2.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/TechnographicsTimeSeriesProduct":{"id":"components/schemas/TechnographicsTimeSeriesProduct","kind":"json-schema","title":"TechnographicsTimeSeriesProduct","data":{"example":{"category":"Customer Relationship Management Applications","current_intensity":72,"data_points":[{"date":"2024-01","intensity":45},{"date":"2024-02","intensity":null},{"date":"2024-03","intensity":51},{"date":"2024-04","intensity":72}],"intensity_momentum":5,"is_active":true,"product_id":22,"product_name":"Salesforce CRM","vendor_name":"Salesforce.com, Inc."},"properties":{"category":{"type":"string","x-struct":null,"x-validate":null},"country_code":{"description":"ISO 3166-1 alpha-2 country code. Populated when granularity is :country, null when :global.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"current_intensity":{"type":"integer","x-struct":null,"x-validate":null},"data_points":{"items":{"$ref":"#/components/schemas/TechnographicsTimeSeriesDataPoint"},"type":"array","x-struct":null,"x-validate":null},"intensity_momentum":{"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"is_active":{"type":"boolean","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},"vendor_name":{"type":"string","x-struct":null,"x-validate":null}},"title":"TechnographicsTimeSeriesProduct","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Technographics.TimeSeries.ProductResult","x-validate":null}},"components/schemas/V2JobSeniority":{"id":"components/schemas/V2JobSeniority","kind":"json-schema","title":"V2JobSeniority","data":{"description":"Job seniority schema","example":{"name":"Director"},"properties":{"name":{"description":"Job seniority name","type":"string","x-struct":null,"x-validate":null}},"required":["name"],"title":"V2JobSeniority","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.JobSeniority","x-validate":null}},"components/schemas/MentionsSort":{"id":"components/schemas/MentionsSort","kind":"json-schema","title":"MentionsSort","data":{"default":"intensity","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to order mentions results. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intensity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": highest-intensity mentions first (default). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_seen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": most recently verified mentions first."},"children":[]}]}]}],"enum":["intensity","last_seen"],"title":"MentionsSort","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.MentionsPagination.Sort","x-validate":null}},"components/schemas/Entitlements":{"id":"components/schemas/Entitlements","kind":"json-schema","title":"Entitlements","data":{"properties":{"companies":{"allOf":[{"$ref":"#/components/schemas/CompanyEntitlements"}],"description":"Company data entitlements, or null if not entitled","nullable":true,"type":"object","x-struct":null,"x-validate":null}},"title":"Entitlements","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Credits.Entitlements","x-validate":null}},"components/schemas/IntentLocationFilter":{"id":"components/schemas/IntentLocationFilter","kind":"json-schema","title":"IntentLocationFilter","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intent location filter — at least one of state_ids, region_names, or country_alpha2s required"},"children":[]}]}]}],"example":{"country_alpha2s":[{"ids":["US","CA"],"inclusion_method":"ANY_PRESENT"}]},"minProperties":1,"properties":{"country_alpha2s":{"description":"Country Alpha-2 code filters","items":{"$ref":"#/components/schemas/CountryCodeFilter"},"minItems":1,"nullable":true,"type":"array","x-struct":null,"x-validate":null},"region_names":{"$ref":"#/components/schemas/AnyNameInclusionFilter"},"state_ids":{"$ref":"#/components/schemas/IdInclusionFilter"}},"title":"IntentLocationFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.Intent.IntentLocationFilter","x-validate":null}},"components/schemas/EnrichFilters":{"id":"components/schemas/EnrichFilters","kind":"json-schema","title":"EnrichFilters","data":{"additionalProperties":false,"description":"Filters for enrich request","properties":{"ai_spend":{"$ref":"#/components/schemas/AiSpendFilters"},"mentions":{"$ref":"#/components/schemas/MentionsFilters"},"spend":{"$ref":"#/components/schemas/SpendFilters"},"technographics":{"$ref":"#/components/schemas/TechnographicsFilters"}},"title":"EnrichFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Filters","x-validate":null}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Spend.Premium":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Spend.Premium","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Spend.Premium","data":{"description":"Spend premium data for a company","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},"category_parent_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parent category ID; null = root category"},"children":[]}]}]}],"nullable":true,"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":{"description":"Total spend in USD","type":"number","x-struct":null,"x-validate":null}},"title":"TalariaWeb.Schemas.V2.Companies.Enrich.Spend.Premium","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Spend.Premium","x-validate":null}},"components/schemas/IntentTopicsSection":{"id":"components/schemas/IntentTopicsSection","kind":"json-schema","title":"IntentTopicsSection","data":{"description":"HG topic intent signals with total count.","properties":{"count":{"description":"Total matching topics (before pagination)","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/IntentTopic"},"type":"array","x-struct":null,"x-validate":null}},"required":["data","count"],"title":"IntentTopicsSection","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.TopicsSection","x-validate":null}},"components/schemas/V2IntentBuyersJourneyResponse":{"id":"components/schemas/V2IntentBuyersJourneyResponse","kind":"json-schema","title":"V2IntentBuyersJourneyResponse","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/V2IntentBuyerJourney"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2IntentBuyersJourneyResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.IntentBuyersJourneyResponse","x-validate":null}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics","data":{"description":"Firmographic data for a company","oneOf":[{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Basic"},{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Full"}],"title":"TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Firmographics","x-validate":null}},"components/schemas/CompanySearchV2EmployeesFilter":{"id":"components/schemas/CompanySearchV2EmployeesFilter","kind":"json-schema","title":"CompanySearchV2EmployeesFilter","data":{"additionalProperties":false,"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":"CompanySearchV2EmployeesFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.EmployeesFilter","x-validate":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.EmployeesFilter"}},"components/schemas/IntentActivitiesSection":{"id":"components/schemas/IntentActivitiesSection","kind":"json-schema","title":"IntentActivitiesSection","data":{"description":"TrustRadius buyer intent activities with total count.","properties":{"count":{"description":"Total matching activities (before pagination)","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/IntentActivity"},"type":"array","x-struct":null,"x-validate":null}},"required":["data","count"],"title":"IntentActivitiesSection","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.ActivitiesSection","x-validate":null}},"components/schemas/CompanyEnrichObject":{"id":"components/schemas/CompanyEnrichObject","kind":"json-schema","title":"CompanyEnrichObject","data":{"description":"Enriched company data","example":{"domain":"example.com","firmographics":{"country_code":"US","domain":"example.com","name":"Example Corp"},"id":"E48EDEB162A5FBFDAF2DCF707079F8F","spend":{"all":[{"category_id":"319D067B229178F03BCFA1DA4AC4DEDE","category_name":"Software","category_parent_id":"ABCD1234229178F03BCFA1DA4AC4DEDE","country_code":"US","spend":125000}],"all_count":1},"technographics":{"installs":[{"country_code":"US","intensity":5,"product_id":814,"product_last_verified_date":"2024-05-20","product_name":"Java","vendor_name":"Oracle"}],"installs_count":1}},"properties":{"ai_maturity":{"allOf":[{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.AiMaturity"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null},"ai_spend":{"description":"AI Spend data","nullable":true,"properties":{"all":{"description":"Array of AI spend records","items":{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Spend"},"type":"array","x-struct":null,"x-validate":null},"all_count":{"description":"Total count of AI spend records","type":"integer","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"cloud_maturity":{"allOf":[{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.CloudMaturity"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null},"contracts":{"description":"Contracts data","nullable":true,"properties":{"count":{"description":"Total count of contracts","type":"integer","x-struct":null,"x-validate":null},"records":{"description":"Array of contract records","items":{"type":"object","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"domain":{"description":"Company domain (populated only when the request includes domains)","nullable":true,"type":"string","x-struct":null,"x-validate":null},"firmographics":{"allOf":[{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null},"id":{"description":"HG company ID (hex-encoded). Null when a requested domain is not tracked by HG; echoes the requested ID when a requested HG ID is not tracked.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"market_benchmarks":{"allOf":[{"$ref":"#/components/schemas/MarketBenchmarks"}],"description":"Peer-group percentile benchmarking against similar organizations","nullable":true,"type":"object","x-struct":null,"x-validate":null},"mentions":{"description":"Mentions data","nullable":true,"properties":{"count":{"description":"Total count of mentions","type":"integer","x-struct":null,"x-validate":null},"records":{"description":"Array of mention records","items":{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Mentions"},"type":"array","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"spend":{"description":"Spend data","nullable":true,"properties":{"all":{"description":"Array of spend records","items":{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Spend"},"type":"array","x-struct":null,"x-validate":null},"all_count":{"description":"Total count of spend records","type":"integer","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"statistics":{"allOf":[{"$ref":"#/components/schemas/Statistics"}],"description":"Aggregated summary statistics across tech stack, spend, contracts, and employees","nullable":true,"type":"object","x-struct":null,"x-validate":null},"technographics":{"description":"Technographics data","nullable":true,"properties":{"installs":{"description":"Array of technology installs","items":{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Technographics"},"type":"array","x-struct":null,"x-validate":null},"installs_count":{"description":"Total count of installs","type":"integer","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null}},"title":"CompanyEnrichObject","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.CompanyEnrichObject","x-validate":null}},"components/schemas/CountryFilter":{"id":"components/schemas/CountryFilter","kind":"json-schema","title":"CountryFilter","data":{"additionalProperties":false,"description":"Filter by country","properties":{"codes":{"description":"Array of ISO 3166-1 alpha-2 country codes (e.g., US, GB, DE)","items":{"maxLength":2,"minLength":2,"type":"string","x-struct":null,"x-validate":null},"maxItems":249,"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"title":"CountryFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.TechnographicsFilters.CountryFilter","x-validate":null}},"components/schemas/IdFilter":{"id":"components/schemas/IdFilter","kind":"json-schema","title":"IdFilter","data":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by hex-encoded IDs and/or names (assumes ANY_PRESENT inclusion method)"},"children":[]}]}]}],"properties":{"ids":{"description":"Array of hex-encoded IDs","items":{"$ref":"#/components/schemas/HexId"},"type":"array","x-struct":null,"x-validate":null},"names":{"description":"Array of entity names for substring matching (case-insensitive)","items":{"minLength":1,"type":"string","x-struct":null,"x-validate":null},"maxItems":10,"type":"array","x-struct":null,"x-validate":null}},"title":"IdFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.TechnographicsFilters.IdFilter","x-validate":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.TechnographicsFilters.IdFilter"}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Basic":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Basic","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Basic","data":{"description":"Firmographic basic data for a company","properties":{"city_name":{"type":"string","x-struct":null,"x-validate":null},"continent_name":{"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},"domain":{"type":"string","x-struct":null,"x-validate":null},"domain_normalized":{"type":"string","x-struct":null,"x-validate":null},"employees_band":{"type":"string","x-struct":null,"x-validate":null},"employees_total":{"type":"integer","x-struct":null,"x-validate":null},"forbes_2000_rank":{"type":"integer","x-struct":null,"x-validate":null},"fortune_500_rank":{"type":"integer","x-struct":null,"x-validate":null},"geopolitical_name":{"type":"string","x-struct":null,"x-validate":null},"id":{"type":"string","x-struct":null,"x-validate":null},"industry_id":{"type":"integer","x-struct":null,"x-validate":null},"industry_name":{"type":"string","x-struct":null,"x-validate":null},"naics_code":{"type":"string","x-struct":null,"x-validate":null},"naics_name":{"type":"string","x-struct":null,"x-validate":null},"name":{"type":"string","x-struct":null,"x-validate":null},"postal_code":{"type":"string","x-struct":null,"x-validate":null},"revenue_band":{"type":"string","x-struct":null,"x-validate":null},"revenue_total":{"type":"number","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},"sic_names":{"items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"state_name":{"type":"string","x-struct":null,"x-validate":null},"subcontinent_name":{"type":"string","x-struct":null,"x-validate":null}},"title":"TalariaWeb.Schemas.V2.Companies.Enrich.Firmographics.Basic","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Firmographics.Basic","x-validate":null}},"components/schemas/V2VendorsResponse":{"id":"components/schemas/V2VendorsResponse","kind":"json-schema","title":"V2VendorsResponse","data":{"description":"Response schema for vendors","example":{"count":1,"data":[{"domain":"https://vendor.com","id":"10056","name":"Vendor Name"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/V2Vendor"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2VendorsResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.VendorsResponse","x-validate":null}},"components/schemas/TechStackSummary":{"id":"components/schemas/TechStackSummary","kind":"json-schema","title":"TechStackSummary","data":{"description":"Summary statistics for a company's technology stack","nullable":true,"properties":{"by_category":{"description":"Product distribution by category (top 20)","items":{"$ref":"#/components/schemas/CategoryDistribution"},"type":"array","x-struct":null,"x-validate":null},"deployment_distribution":{"allOf":[{"$ref":"#/components/schemas/DeploymentDistribution"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null},"total_categories":{"description":"Total unique categories","minimum":0,"type":"integer","x-struct":null,"x-validate":null},"total_products":{"description":"Total installed products","minimum":0,"type":"integer","x-struct":null,"x-validate":null},"total_vendors":{"description":"Total unique vendors","minimum":0,"type":"integer","x-struct":null,"x-validate":null},"vendor_concentration":{"allOf":[{"$ref":"#/components/schemas/VendorConcentration"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null}},"title":"TechStackSummary","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Statistics.TechStackSummary","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/Credits":{"id":"components/schemas/Credits","kind":"json-schema","title":"Credits","data":{"properties":{"consumed":{"description":"Credits consumed so far","example":500,"type":"integer","x-struct":null,"x-validate":null},"percentage_consumed":{"description":"Percentage of credits consumed","example":25,"format":"float","type":"number","x-struct":null,"x-validate":null},"remaining":{"description":"Credits remaining","example":1500,"type":"integer","x-struct":null,"x-validate":null},"total":{"description":"Total credits in contract","example":2000,"type":"integer","x-struct":null,"x-validate":null}},"title":"Credits","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Credits.Credits","x-validate":null}},"components/schemas/ProductAttributeFilter":{"id":"components/schemas/ProductAttributeFilter","kind":"json-schema","title":"ProductAttributeFilter","data":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by product attribute IDs (assumes ANY_PRESENT inclusion method)"},"children":[]}]}]}],"properties":{"ids":{"description":"Array of product attribute IDs","items":{"type":"integer","x-struct":null,"x-validate":null},"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"required":["ids"],"title":"ProductAttributeFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.TechnographicsFilters.ProductAttributeFilter","x-validate":null}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Mentions":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Mentions","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Mentions","data":{"allOf":[{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Mentions.Full"}],"description":"Mention data for a company","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Mentions","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Mentions","x-validate":null}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Technographics":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Technographics","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Technographics","data":{"description":"Technology install/usage data","oneOf":[{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Basic"},{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Full"}],"title":"TalariaWeb.Schemas.V2.Companies.Enrich.Technographics","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Technographics","x-validate":null}},"components/schemas/NaicsMapping":{"id":"components/schemas/NaicsMapping","kind":"json-schema","title":"NaicsMapping","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NAICS 2012 code + its top-parent sector."},"children":[]}]}]}],"properties":{"display_name_with_level":{"description":"Disambiguating label including hierarchy level and code.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"hierarchy_level":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NAICS hierarchy level. national_industry is a leaf; others are rollups."},"children":[]}]}]}],"enum":["sector","subsector","industry_group","naics_industry","national_industry"],"nullable":true,"type":"string","x-struct":null,"x-validate":null},"is_leaf":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True when naics_code is a 6-digit leaf — the most specific level."},"children":[]}]}]}],"nullable":true,"type":"boolean","x-struct":null,"x-validate":null},"naics_code":{"description":"NAICS 2012 code (e.g. '541511').","nullable":true,"type":"string","x-struct":null,"x-validate":null},"naics_name":{"description":"NAICS 2012 label.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"naics_top_parent_code":{"description":"Top-parent NAICS sector code (e.g. '54').","nullable":true,"type":"string","x-struct":null,"x-validate":null},"naics_top_parent_name":{"description":"Top-parent NAICS sector name.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"sic_count":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of distinct SIC codes mapped to this NAICS code. Only set when taxonomy=naics."},"children":[]}]}]}],"nullable":true,"type":"integer","x-struct":null,"x-validate":null}},"title":"NaicsMapping","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Industries.Search.NaicsMapping","x-validate":null}},"components/schemas/V2ProductAttributesResponse":{"id":"components/schemas/V2ProductAttributesResponse","kind":"json-schema","title":"V2ProductAttributesResponse","data":{"description":"Response schema for product attributes","example":{"count":1,"data":[{"children_attributes":[{"description":"Cloud APM software","id":2,"level":2,"name":"Cloud Application Performance Management"}],"description":"Cloud Computing","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/V2ProductAttribute"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2ProductAttributesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.ProductAttributesResponse","x-validate":null}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Premium":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Premium","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Premium","data":{"description":"Technology install/usage premium data","properties":{"intensity":{"type":"integer","x-struct":null,"x-validate":null},"location_count":{"type":"integer","x-struct":null,"x-validate":null},"product_first_verified_date":{"format":"date-time","type":"string","x-struct":null,"x-validate":null}},"title":"TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Premium","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Technographics.Premium","x-validate":null}},"components/schemas/V2ProductCategoriesResponse":{"id":"components/schemas/V2ProductCategoriesResponse","kind":"json-schema","title":"V2ProductCategoriesResponse","data":{"description":"Response schema for product categories","example":{"count":1,"data":[{"id":"27B2ABE74F4C890C51B3552F493C59","name":"Digital","name_tree":["Hardware","Network Infrastructure","Digital"],"parent_id":"28BA2E5CA3FD12249780BEC076859985"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/V2ProductCategory"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2ProductCategoriesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.ProductCategoriesResponse","x-validate":null}},"components/schemas/ContactsSearchRequest":{"id":"components/schemas/ContactsSearchRequest","kind":"json-schema","title":"ContactsSearchRequest","data":{"additionalProperties":false,"description":"Search and filter contacts. Returns a flat list of matching contacts.","example":{"filters":{"companies":{"ids":["1698C53EBC888758570396E0334965C1"]},"contact_location":{"countries":["US"]},"job_functions":["Engineering"],"job_seniority":["Director"],"time_in_current_role":["company_veteran"]},"limit":10,"offset":0},"properties":{"filters":{"$ref":"#/components/schemas/ContactSearchV2Filters"},"limit":{"default":10,"description":"Maximum number of contacts to return","maximum":20,"minimum":1,"type":"integer","x-struct":null,"x-validate":null},"offset":{"default":0,"description":"Number of contacts to skip (max 99)","maximum":99,"minimum":0,"type":"integer","x-struct":null,"x-validate":null}},"required":["filters"],"title":"ContactsSearchRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contacts.Search.Request","x-validate":"Elixir.TalariaWeb.Schemas.V2.Contacts.Search.Request"}},"components/schemas/V2FAIDepartment":{"id":"components/schemas/V2FAIDepartment","kind":"json-schema","title":"V2FAIDepartment","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","items":{"$ref":"#/components/schemas/V2FAIRole"},"type":"array","x-struct":null,"x-validate":null}},"required":["id","name","roles"],"title":"V2FAIDepartment","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.FaiDepartment","x-validate":null}},"components/schemas/AnyNoneNameInclusionFilter":{"id":"components/schemas/AnyNoneNameInclusionFilter","kind":"json-schema","title":"AnyNoneNameInclusionFilter","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/AnyNoneInclusionMethod"}},"required":["ids","inclusion_method"],"title":"AnyNoneNameInclusionFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.AnyNoneNameInclusionFilter","x-validate":null}},"components/schemas/RequestPagination":{"id":"components/schemas/RequestPagination","kind":"json-schema","title":"RequestPagination","data":{"additionalProperties":false,"description":"Pagination parameters for companies and nested data","properties":{"ai_spend":{"$ref":"#/components/schemas/SpendPagination"},"mentions":{"$ref":"#/components/schemas/MentionsPagination"},"spend":{"$ref":"#/components/schemas/SpendPagination"},"technographics":{"$ref":"#/components/schemas/TechnographicsPagination"}},"title":"RequestPagination","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.RequestPagination","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/ContractSearchV2Sort":{"id":"components/schemas/ContractSearchV2Sort","kind":"json-schema","title":"ContractSearchV2Sort","data":{"additionalProperties":false,"description":"A sort object for contract search results","example":{"direction":"DESC","field":"end_date"},"properties":{"direction":{"$ref":"#/components/schemas/ContractSearchV2SortDirection"},"field":{"enum":["deal_value","end_date","start_date","announcement_date"],"type":"string","x-struct":null,"x-validate":null}},"required":["field","direction"],"title":"ContractSearchV2Sort","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contracts.Search.Sort","x-validate":null}},"components/schemas/IntentActivitiesFilters":{"id":"components/schemas/IntentActivitiesFilters","kind":"json-schema","title":"IntentActivitiesFilters","data":{"additionalProperties":false,"description":"Filters that apply only to the activities (TrustRadius buyer intent) section.","properties":{"product_category_ids":{"description":"Filter by product category IDs (TrustRadius activities only)","example":["27B2ABE74F4C890C51B3552F493C59"],"items":{"$ref":"#/components/schemas/HexId"},"type":"array","x-struct":null,"x-validate":null}},"title":"IntentActivitiesFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.ActivitiesFilters","x-validate":null}},"components/schemas/TechnographicsTimeSeriesResponse":{"id":"components/schemas/TechnographicsTimeSeriesResponse","kind":"json-schema","title":"TechnographicsTimeSeriesResponse","data":{"example":{"company":{"id":"E48EDEB162A5FBFDAF2DCF707079F8F","name":"Walmart Inc."},"products":[{"category":"Customer Relationship Management Applications","current_intensity":72,"data_points":[{"date":"2024-01","intensity":45},{"date":"2024-02","intensity":null},{"date":"2024-03","intensity":51},{"date":"2024-04","intensity":72}],"intensity_momentum":5,"is_active":true,"product_id":22,"product_name":"Salesforce CRM","vendor_name":"Salesforce.com, Inc."}],"time_range":{"end":"2025-07","start":"2023-07"}},"properties":{"company":{"type":"object","x-struct":null,"x-validate":null},"products":{"items":{"$ref":"#/components/schemas/TechnographicsTimeSeriesProduct"},"type":"array","x-struct":null,"x-validate":null},"time_range":{"type":"object","x-struct":null,"x-validate":null}},"title":"TechnographicsTimeSeriesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Technographics.TimeSeries.Response","x-validate":null}},"components/schemas/MarketBenchmarks":{"id":"components/schemas/MarketBenchmarks","kind":"json-schema","title":"MarketBenchmarks","data":{"description":"Peer-group percentile benchmarking against similar organizations","nullable":true,"properties":{"computed_at":{"description":"When market benchmarks were computed","format":"date","nullable":true,"type":"string","x-struct":null,"x-validate":null},"peer_group":{"allOf":[{"$ref":"#/components/schemas/PeerGroup"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null},"similar_organizations":{"description":"List of similar organizations","items":{"$ref":"#/components/schemas/SimilarOrganization"},"type":"array","x-struct":null,"x-validate":null},"spend_benchmarks":{"allOf":[{"$ref":"#/components/schemas/SpendBenchmarks"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null},"technology_benchmarks":{"allOf":[{"$ref":"#/components/schemas/TechnologyBenchmarks"}],"nullable":true,"type":"object","x-struct":null,"x-validate":null}},"title":"MarketBenchmarks","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.MarketBenchmarks","x-validate":null}},"components/schemas/FunctionalAreasSort":{"id":"components/schemas/FunctionalAreasSort","kind":"json-schema","title":"FunctionalAreasSort","data":{"additionalProperties":false,"description":"A sort object for FAI results","example":{"direction":"DESC","field":"department_usage_share"},"properties":{"direction":{"$ref":"#/components/schemas/FunctionalAreasSortDirection"},"field":{"description":"Field to sort by","enum":["department_usage_share","department_signal_strength","role_usage_share","role_signal_strength_at_location","product_name","department_name","role_name","country_name"],"type":"string","x-struct":null,"x-validate":null}},"required":["field","direction"],"title":"FunctionalAreasSort","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.FunctionalAreas.Sort","x-validate":null}},"components/schemas/FunctionalArea":{"id":"components/schemas/FunctionalArea","kind":"json-schema","title":"FunctionalArea","data":{"description":"A single FAI record.","properties":{"city_name":{"description":"City name","type":"string","x-struct":null,"x-validate":null},"country_name":{"description":"Country name","type":"string","x-struct":null,"x-validate":null},"decision_maker_titles":{"description":"Titles of decision makers","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"department_id":{"description":"Department ID (hex-encoded)","type":"string","x-struct":null,"x-validate":null},"department_name":{"description":"Department name","type":"string","x-struct":null,"x-validate":null},"department_signal_strength":{"description":"Department signal strength","type":"integer","x-struct":null,"x-validate":null},"department_usage_share":{"description":"Department usage share","format":"float","type":"number","x-struct":null,"x-validate":null},"first_verified_at":{"description":"First verified date","type":"string","x-struct":null,"x-validate":null},"has_decision_maker":{"description":"Whether a decision maker is present","type":"boolean","x-struct":null,"x-validate":null},"has_influencer":{"description":"Whether an influencer is present","type":"boolean","x-struct":null,"x-validate":null},"influencer_titles":{"description":"Titles of influencers","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"last_verified_at":{"description":"Last verified date","type":"string","x-struct":null,"x-validate":null},"product_id":{"description":"Product ID","type":"integer","x-struct":null,"x-validate":null},"product_name":{"description":"Product name","type":"string","x-struct":null,"x-validate":null},"role_id":{"description":"Role ID (hex-encoded)","nullable":true,"type":"string","x-struct":null,"x-validate":null},"role_name":{"description":"Role name","nullable":true,"type":"string","x-struct":null,"x-validate":null},"role_signal_strength_at_location":{"description":"Role signal strength at location","format":"float","nullable":true,"type":"number","x-struct":null,"x-validate":null},"role_usage_share":{"description":"Role usage share","format":"float","nullable":true,"type":"number","x-struct":null,"x-validate":null},"state_name":{"description":"State name","type":"string","x-struct":null,"x-validate":null},"vendor_id":{"description":"Vendor ID","type":"integer","x-struct":null,"x-validate":null},"vendor_name":{"description":"Vendor name","type":"string","x-struct":null,"x-validate":null}},"title":"FunctionalArea","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.FunctionalAreas.FunctionalArea","x-validate":null}},"components/schemas/ContactSearchV2ContactResult":{"id":"components/schemas/ContactSearchV2ContactResult","kind":"json-schema","title":"ContactSearchV2ContactResult","data":{"description":"A contact returned from search","properties":{"company_domain":{"description":"Company domain","nullable":true,"type":"string","x-struct":null,"x-validate":null},"company_id":{"description":"Company identifier","nullable":true,"type":"string","x-struct":null,"x-validate":null},"company_name":{"description":"Company name","nullable":true,"type":"string","x-struct":null,"x-validate":null},"contact_location_city":{"description":"Contact location city","nullable":true,"type":"string","x-struct":null,"x-validate":null},"contact_location_country":{"description":"Contact location country","nullable":true,"type":"string","x-struct":null,"x-validate":null},"contact_location_region":{"description":"Contact location region","nullable":true,"type":"string","x-struct":null,"x-validate":null},"first_name":{"description":"Contact first name","nullable":true,"type":"string","x-struct":null,"x-validate":null},"full_name":{"description":"Contact full name","nullable":true,"type":"string","x-struct":null,"x-validate":null},"id":{"description":"Contact identifier","type":"string","x-struct":null,"x-validate":null},"job_functions":{"description":"Contact job functions","items":{"type":"string","x-struct":null,"x-validate":null},"nullable":true,"type":"array","x-struct":null,"x-validate":null},"job_seniority":{"description":"Contact job seniority","nullable":true,"type":"string","x-struct":null,"x-validate":null},"job_title":{"description":"Contact job title","nullable":true,"type":"string","x-struct":null,"x-validate":null},"last_name":{"description":"Contact last name","nullable":true,"type":"string","x-struct":null,"x-validate":null},"linkedin_url":{"description":"Contact LinkedIn URL","nullable":true,"type":"string","x-struct":null,"x-validate":null}},"title":"ContactSearchV2ContactResult","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contacts.Search.ContactResult","x-validate":null}},"components/schemas/CompaniesFilter":{"id":"components/schemas/CompaniesFilter","kind":"json-schema","title":"CompaniesFilter","data":{"additionalProperties":false,"description":"Filter companies by IDs or domains (mutually exclusive)","example":{"ids":["E48EDEB162A5FBFDAF2DCF707079F8F","1698C53EBC888758570396E0334965C1"]},"properties":{"domains":{"description":"Array of company domains (e.g., example.com)","items":{"type":"string","x-struct":null,"x-validate":null},"maxItems":25,"minItems":1,"type":"array","x-struct":null,"x-validate":null},"ids":{"description":"Array of hex-encoded company IDs","items":{"$ref":"#/components/schemas/HexId"},"maxItems":25,"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"title":"CompaniesFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.CompaniesFilter","x-validate":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.CompaniesFilter"}},"components/schemas/V2SICUS1987Response":{"id":"components/schemas/V2SICUS1987Response","kind":"json-schema","title":"V2SICUS1987Response","data":{"description":"Response schema for SIC US 1987","example":{"count":1,"data":[{"code":"33636","code_standard":"5912","id":"3FCEDF144BE9F3DFF1145DB6C515FB34","name":"Foo Bar","parent_id":"264DD858DB942CAD06F24FF25DF56716"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/V2SICUS1987"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2SICUS1987Response","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.SicUS1987Response","x-validate":null}},"components/schemas/ContractSearchV2Sorts":{"id":"components/schemas/ContractSearchV2Sorts","kind":"json-schema","title":"ContractSearchV2Sorts","data":{"default":[],"description":"List of sort objects","items":{"$ref":"#/components/schemas/ContractSearchV2Sort"},"title":"ContractSearchV2Sorts","type":"array","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contracts.Search.Sorts","x-validate":null}},"components/schemas/ServiceUnavailableResponse":{"id":"components/schemas/ServiceUnavailableResponse","kind":"json-schema","title":"ServiceUnavailableResponse","data":{"properties":{"errors":{"items":{"properties":{"detail":{"example":"Unable to verify credit availability. Please try again later. If the error persists, contact customersupport@hginsights.com.","type":"string","x-struct":null,"x-validate":null},"source":{"nullable":true,"type":"string","x-struct":null,"x-validate":null},"title":{"example":"Service unavailable","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":"ServiceUnavailableResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Error.ServiceUnavailableResponse","x-validate":null}},"components/schemas/IntentCompany":{"id":"components/schemas/IntentCompany","kind":"json-schema","title":"IntentCompany","data":{"additionalProperties":false,"description":"Resolved company information.","nullable":true,"properties":{"domain":{"description":"Company domain","nullable":true,"type":"string","x-struct":null,"x-validate":null},"id":{"description":"HG company ID (hex-encoded)","example":"1698C53EBC888758570396E0334965C1","type":"string","x-struct":null,"x-validate":null},"name":{"description":"Company name","nullable":true,"type":"string","x-struct":null,"x-validate":null}},"title":"IntentCompany","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.Company","x-validate":null}},"components/schemas/ContactsSearchResponse":{"id":"components/schemas/ContactsSearchResponse","kind":"json-schema","title":"ContactsSearchResponse","data":{"description":"Flat list of contacts matching the search criteria.","example":{"contacts":[{"company_domain":"acme.com","company_id":"1488903ED478F8C51D09F2EC5F2DCDA2","company_name":"Acme","contact_location_city":"Vancouver","contact_location_country":"Canada","contact_location_region":"British Columbia","first_name":"John","full_name":"John Doe","id":"7a932d2ae5dab0ca88348198c9129c9167ff34f92c4abd47f291f5d1c35d237a","job_functions":["Operations"],"job_seniority":"Founder","job_title":"Co-Founder","last_name":"Doe","linkedin_url":"https://www.linkedin.com/in/john-dow"}],"count":1},"properties":{"contacts":{"items":{"$ref":"#/components/schemas/ContactSearchV2ContactResult"},"type":"array","x-struct":null,"x-validate":null},"count":{"description":"Total number of contacts matching the filters (before pagination)","type":"integer","x-struct":null,"x-validate":null}},"required":["contacts"],"title":"ContactsSearchResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contacts.Search.Response","x-validate":null}},"components/schemas/IndustryMapping":{"id":"components/schemas/IndustryMapping","kind":"json-schema","title":"IndustryMapping","data":{"description":"HG industry bucket (23 curated values, or null when unmapped).","properties":{"industry_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HG industry id (0/None = unmapped)."},"children":[]}]}]}],"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"industry_name":{"description":"HG industry name.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"naics_count":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of distinct NAICS codes mapped to this HG industry. Only set when taxonomy=industry."},"children":[]}]}]}],"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"sic_count":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of distinct SIC codes mapped to this HG industry. Only set when taxonomy=industry."},"children":[]}]}]}],"nullable":true,"type":"integer","x-struct":null,"x-validate":null}},"title":"IndustryMapping","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Industries.Search.IndustryMapping","x-validate":null}},"components/schemas/V2ProductCategory":{"id":"components/schemas/V2ProductCategory","kind":"json-schema","title":"V2ProductCategory","data":{"description":"Product Category schema","example":{"id":"27B2ABE74F4C890C51B3552F493C59","name":"Digital","name_tree":["Hardware","Network Infrastructure","Digital"],"parent_id":"28BA2E5CA3FD12249780BEC076859985"},"properties":{"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"Product Category name","type":"string","x-struct":null,"x-validate":null},"name_tree":{"description":"Product Category name tree","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"parent_id":{"description":"Parent Product Category ID","type":"string","x-struct":null,"x-validate":null}},"required":["id","name","name_tree","parent_id"],"title":"V2ProductCategory","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.ProductCategory","x-validate":null}},"components/schemas/AnyNoneCodeOrIdInclusionFilter":{"id":"components/schemas/AnyNoneCodeOrIdInclusionFilter","kind":"json-schema","title":"AnyNoneCodeOrIdInclusionFilter","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inclusion filter accepting either hex-encoded HG IDs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or standard code strings ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), together with an inclusion method. Exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]}],"example":{"codes":["5221","5222"],"inclusion_method":"ANY_PRESENT"},"oneOf":[{"$ref":"#/components/schemas/AnyNoneIdInclusionFilter"},{"$ref":"#/components/schemas/AnyNoneCodeInclusionFilter"}],"title":"AnyNoneCodeOrIdInclusionFilter","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.AnyNoneCodeOrIdInclusionFilter","x-validate":null}},"components/schemas/ContractSearchV2DealValueRange":{"id":"components/schemas/ContractSearchV2DealValueRange","kind":"json-schema","title":"ContractSearchV2DealValueRange","data":{"additionalProperties":false,"description":"Deal value range filter with optional min and max bounds.","properties":{"max":{"description":"Maximum deal value (inclusive)","type":"integer","x-struct":null,"x-validate":null},"min":{"description":"Minimum deal value (inclusive)","type":"integer","x-struct":null,"x-validate":null}},"title":"ContractSearchV2DealValueRange","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contracts.Search.DealValueRange","x-validate":null}},"components/schemas/TechnographicsSort":{"id":"components/schemas/TechnographicsSort","kind":"json-schema","title":"TechnographicsSort","data":{"default":"intensity","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to order technographics results. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intensity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": highest-intensity products first (default). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_seen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": most recently verified products first, i.e. sorted by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_last_verified_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response field."},"children":[]}]}]}],"enum":["intensity","last_seen"],"title":"TechnographicsSort","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.TechnographicsPagination.Sort","x-validate":null}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.CloudMaturity.Full":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.CloudMaturity.Full","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.CloudMaturity.Full","data":{"description":"Cloud maturity data for a company","properties":{"aws_products_count":{"description":"Distinct AWS products/services detected. 0 if none.","type":"integer","x-struct":null,"x-validate":null},"azure_products_count":{"description":"Distinct Azure products/services detected. 0 if none.","type":"integer","x-struct":null,"x-validate":null},"cloud_stack_percent_change":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change in cloud percent over period. Positive = growing cloud share."},"children":[]}]}]}],"maximum":90,"minimum":-100,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"current_products_used_cloud_count":{"description":"Cloud products in current tech stack","nullable":true,"type":"integer","x-struct":null,"x-validate":null},"current_products_used_cloud_percent":{"description":"Percent of current stack that is cloud (0-100)","maximum":100,"minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"current_products_used_total_count":{"description":"Total products detected in current tech stack (products verified in the last 24 months)","nullable":true,"type":"integer","x-struct":null,"x-validate":null},"gcp_products_count":{"description":"Distinct GCP products/services detected. 0 if none.","type":"integer","x-struct":null,"x-validate":null},"new_products_used_cloud_count":{"description":"Cloud products added in last 18 months. Null if no new services.","nullable":true,"type":"integer","x-struct":null,"x-validate":null},"new_products_used_cloud_percent":{"description":"Cloud percent of new services window (0-100). Null if no new services.","maximum":100,"minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"new_products_used_total_count":{"description":"Products added in last 18 months. Null if no new services detected.","nullable":true,"type":"integer","x-struct":null,"x-validate":null}},"title":"TalariaWeb.Schemas.V2.Companies.Enrich.CloudMaturity.Full","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.CloudMaturity.Full","x-validate":null}},"components/schemas/TechnographicsLimit":{"id":"components/schemas/TechnographicsLimit","kind":"json-schema","title":"TechnographicsLimit","data":{"default":10,"description":"The number of technographics records to return in the request.","maximum":100,"title":"TechnographicsLimit","type":"integer","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.TechnographicsPagination.Limit","x-validate":null}},"components/schemas/CompanySearchV2SortFieldNames":{"id":"components/schemas/CompanySearchV2SortFieldNames","kind":"json-schema","title":"CompanySearchV2SortFieldNames","data":{"description":"Allowed fields to sort by. Includes ranking signals that are filterable/sortable but not returned as columns.","enum":["id","name","domain","domain_normalized","ai_maturity_score","ai_maturity_rank","ai_maturity_6m_delta","genai_intent_score","current_products_used_cloud_percent","cloud_stack_percent_change"],"title":"CompanySearchV2SortFieldNames","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Search.SortFieldNames","x-validate":null}},"components/schemas/V2IntentContextTypesResponse":{"id":"components/schemas/V2IntentContextTypesResponse","kind":"json-schema","title":"V2IntentContextTypesResponse","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/V2IntentContextType"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2IntentContextTypesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.IntentContextTypesResponse","x-validate":null}},"components/schemas/CompanySearchV2SpendFilter":{"id":"components/schemas/CompanySearchV2SpendFilter","kind":"json-schema","title":"CompanySearchV2SpendFilter","data":{"additionalProperties":false,"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/CompanySearchV2RangeFilter"}},"required":["categories","range"],"title":"CompanySearchV2SpendFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.SpendFilter","x-validate":null}},"components/schemas/CompanySearchV2Filters":{"id":"components/schemas/CompanySearchV2Filters","kind":"json-schema","title":"CompanySearchV2Filters","data":{"additionalProperties":false,"description":"Filters object","example":{"ai_maturity":{"ai_maturity_6m_delta":{"max":100,"min":25},"ai_maturity_rank":{"max":100,"min":25},"ai_maturity_score":{"max":100,"min":25},"ai_product_use":false,"data_maturity_level":["LOW"],"dominant_cloud_provider":[""],"genai_intent_score":{"max":100,"min":25}},"cloud_maturity":{"aws_products_count":{"max":100,"min":25},"azure_products_count":{"max":100,"min":25},"cloud_stack_percent_change":{"max":0,"min":-100},"current_products_used_cloud_percent":{"max":100,"min":25},"current_products_used_total_count":{"max":100,"min":25},"gcp_products_count":{"max":100,"min":25},"new_products_used_cloud_percent":{"max":100,"min":25}},"company_identifiers":{"company_ids":{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"ANY_PRESENT"}},"corporate_hierarchy":{"is_domestic_parent":true,"is_global_headquarters":true},"firmographics":{"company_level":"CORPORATE_PARENT","country_codes":[{"ids":["US"],"inclusion_method":"ANY_PRESENT"}],"employees":{"has_fixed_employees":true,"max":2500000,"min":1500000},"industries":[{"ids":[16],"inclusion_method":"ANY_PRESENT"}],"naics_codes":[{"codes":["5221","5222"],"inclusion_method":"ANY_PRESENT"}],"region_names":{"ids":["AMER"],"inclusion_method":"ANY_PRESENT"},"revenue":{"has_fixed_revenue":true,"max":700000000000,"min":600000000000},"sic_codes":[{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"NONE_PRESENT"}]},"installs":{"country":{"codes":["US"]},"product_attributes":{"ids":[222],"inclusion_method":"ANY_PRESENT","install_age_months":{"max":18,"min":3}},"product_categories":{"ids":["319D067B229178F03BCFA1DA4AC4DEDE"],"inclusion_method":"ANY_PRESENT","install_age":{"max":12}},"product_last_verified_date":{"max":"2024-12-31","min":"2024-01-01"},"products":[{"fai":{"departments":{"ids":["A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"],"inclusion_method":"ANY_PRESENT"}},"ids":[814],"inclusion_method":"ANY_PRESENT","install_age":{"max":24,"min":6}}],"vendors":[{"ids":[316],"inclusion_method":"ANY_PRESENT","product_count":{"min":5}}]},"intent":{"context_type_ids":{"ids":["DEF456789012345678901234ABCDEF12"],"inclusion_method":"ANY_PRESENT"},"location":{"country_alpha2s":[{"ids":["US","CA"],"inclusion_method":"ANY_PRESENT"}]},"signal_score":"MEDIUM","topics":{"ids":["19861D3AC60455102792F87A33AF533F"],"inclusion_method":"ANY_PRESENT"}},"spend":[{"categories":{"ids":["3B36D42E7F8E60BE58BA4356B6AF40C"],"inclusion_method":"ANY_PRESENT"},"range":{"min":2000000000}}]},"properties":{"ai_maturity":{"$ref":"#/components/schemas/CompanySearchV2AiMaturityFilter"},"ai_spend":{"description":"Filter results based on AI spend filters","items":{"$ref":"#/components/schemas/CompanySearchV2AiSpendFilter"},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"cloud_maturity":{"$ref":"#/components/schemas/CompanySearchV2CloudMaturityFilter"},"company_identifiers":{"$ref":"#/components/schemas/CompanyIdentifierFilters"},"corporate_hierarchy":{"$ref":"#/components/schemas/CompanyCorporateHierarchyFilters"},"firmographics":{"$ref":"#/components/schemas/CompanySearchV2FirmographicFilters"},"installs":{"$ref":"#/components/schemas/CompanySearchV2InstallsFilters"},"intent":{"$ref":"#/components/schemas/CompanyFiltersIntent"},"spend":{"description":"Filter results based on spend filters","items":{"$ref":"#/components/schemas/CompanySearchV2SpendFilter"},"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"title":"CompanySearchV2Filters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters","x-validate":null}},"components/schemas/CompaniesMatchResponse":{"id":"components/schemas/CompaniesMatchResponse","kind":"json-schema","title":"CompaniesMatchResponse","data":{"description":"Batch match results, one entry per input company in the same order","example":{"companies":[{"country":"US","domain":"ford.com","matches":[{"country":"US","domain":"ford.com","id":"3AE6DA985017C625659E242A074C5A88","matched_on":["name","domain","country"],"name":"Ford Motor Company"}],"name":"Ford Motor Company"},{"domain":"lehlvksjbdvsdf.com","matches":[]}]},"properties":{"companies":{"items":{"$ref":"#/components/schemas/MatchedCompany"},"type":"array","x-struct":null,"x-validate":null}},"required":["companies"],"title":"CompaniesMatchResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Match.Response","x-validate":null}},"components/schemas/HierarchyResponse":{"id":"components/schemas/HierarchyResponse","kind":"json-schema","title":"HierarchyResponse","data":{"description":"Response body for the hierarchy endpoint.","example":{"count":110,"hierarchy":{"children":[],"company_level":"Group HQ","id":"1698C53EBC888758570396E0334965C1","name":"Walmart Inc.","parent_id":null,"selected":false}},"properties":{"count":{"description":"Total number of entities in the hierarchy (DB row count, capped at 1200).","type":"integer","x-struct":null,"x-validate":null},"hierarchy":{"description":"Root node of the hierarchy tree, or null if the company was not found.","nullable":true,"type":"object","x-struct":null,"x-validate":null},"meta":{"description":"Metadata about the hierarchy results.","properties":{"total_matched":{"description":"Number of entities matching the applied filters.","type":"integer","x-struct":null,"x-validate":null},"total_unfiltered":{"description":"Number of entities before filters were applied.","type":"integer","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null}},"title":"HierarchyResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Hierarchy.Response","x-validate":null}},"components/schemas/IntentTopic":{"id":"components/schemas/IntentTopic","kind":"json-schema","title":"IntentTopic","data":{"description":"An HG topic intent signal.","properties":{"buyers_journey_name":{"description":"Buyer's journey name","nullable":true,"type":"string","x-struct":null,"x-validate":null},"buyers_journey_names":{"description":"Deduped buyer's journey names (populated when granularity is set, null otherwise)","items":{"type":"string","x-struct":null,"x-validate":null},"nullable":true,"type":"array","x-struct":null,"x-validate":null},"context_dispositions":{"description":"Context dispositions","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"context_type_names":{"description":"Context type names","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"country_name":{"description":"Country name","nullable":true,"type":"string","x-struct":null,"x-validate":null},"id":{"description":"Topic ID","type":"string","x-struct":null,"x-validate":null},"last_seen_at":{"description":"Last seen date","format":"date","nullable":true,"type":"string","x-struct":null,"x-validate":null},"location_count":{"description":"Number of distinct locations with signal (populated at global/region/country granularity, null otherwise)","nullable":true,"type":"integer","x-struct":null,"x-validate":null},"location_strength":{"description":"Location-based signal strength score","nullable":true,"type":"integer","x-struct":null,"x-validate":null},"name":{"description":"Topic display name","type":"string","x-struct":null,"x-validate":null},"product_names":{"description":"Product names","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"region_name":{"description":"Geographic region name","nullable":true,"type":"string","x-struct":null,"x-validate":null},"score":{"description":"Signal score","type":"number","x-struct":null,"x-validate":null},"signal_level":{"description":"Signal level (HIGH/MEDIUM/LOW)","type":"string","x-struct":null,"x-validate":null},"source":{"description":"Source of the signal","enum":["hg"],"type":"string","x-struct":null,"x-validate":null},"state_name":{"description":"US state name","nullable":true,"type":"string","x-struct":null,"x-validate":null},"trend":{"description":"Signal trend","nullable":true,"type":"number","x-struct":null,"x-validate":null},"vendor_names":{"description":"Vendor names","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"title":"IntentTopic","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.TopicItem","x-validate":null}},"components/schemas/V2IntentBuyerJourney":{"id":"components/schemas/V2IntentBuyerJourney","kind":"json-schema","title":"V2IntentBuyerJourney","data":{"description":"Intent Buyer Journey schema","example":{"description":"Foo bar description","id":"2E64D9D97CF79E96941A831E40507CA2","name":"Evaluating"},"properties":{"description":{"description":"Intent Buyer Journey description","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":"V2IntentBuyerJourney","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.IntentBuyersJourney","x-validate":null}},"components/schemas/IndustrySearchPagination":{"id":"components/schemas/IndustrySearchPagination","kind":"json-schema","title":"IndustrySearchPagination","data":{"description":"Pagination metadata.","properties":{"has_more":{"description":"True when more rows are available.","type":"boolean","x-struct":null,"x-validate":null},"limit":{"description":"Requested page size.","type":"integer","x-struct":null,"x-validate":null},"offset":{"description":"Requested offset.","type":"integer","x-struct":null,"x-validate":null},"offset_exceeds_total":{"description":"True when the caller paged past the end of the result set.","type":"boolean","x-struct":null,"x-validate":null},"total":{"description":"Total rows matching the query.","type":"integer","x-struct":null,"x-validate":null},"total_pages":{"description":"Total pages available.","type":"integer","x-struct":null,"x-validate":null}},"required":["total","limit","offset","has_more","total_pages"],"title":"IndustrySearchPagination","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Industries.Search.IndustrySearchPagination","x-validate":null}},"components/schemas/MatchedCompany":{"id":"components/schemas/MatchedCompany","kind":"json-schema","title":"MatchedCompany","data":{"description":"Input company echoed back with its match results","properties":{"country":{"description":"Input company country","type":"string","x-struct":null,"x-validate":null},"customer_id":{"description":"Caller-provided identifier echoed back for correlation","nullable":true,"type":"string","x-struct":null,"x-validate":null},"domain":{"description":"Input company domain","type":"string","x-struct":null,"x-validate":null},"matches":{"description":"Match results sorted by relevance","items":{"$ref":"#/components/schemas/MatchResult"},"type":"array","x-struct":null,"x-validate":null},"name":{"description":"Input company name","type":"string","x-struct":null,"x-validate":null}},"required":["matches"],"title":"MatchedCompany","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Match.MatchedCompany","x-validate":null}},"components/schemas/V2CountriesResponse":{"id":"components/schemas/V2CountriesResponse","kind":"json-schema","title":"V2CountriesResponse","data":{"description":"Response schema for countries","example":{"count":1,"data":[{"code":"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/V2Country"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2CountriesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.CountriesResponse","x-validate":null}},"components/schemas/TechnographicsPagination":{"id":"components/schemas/TechnographicsPagination","kind":"json-schema","title":"TechnographicsPagination","data":{"additionalProperties":false,"description":"Pagination parameters for technographics data","properties":{"limit":{"$ref":"#/components/schemas/TechnographicsLimit"},"offset":{"$ref":"#/components/schemas/Offset"},"sort":{"$ref":"#/components/schemas/TechnographicsSort"}},"title":"TechnographicsPagination","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.TechnographicsPagination","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/CompaniesEnrichRequest":{"id":"components/schemas/CompaniesEnrichRequest","kind":"json-schema","title":"CompaniesEnrichRequest","data":{"additionalProperties":false,"description":"Request to enrich company data with firmographics, spend, and technographics","example":{"companies":{"ids":["E48EDEB162A5FBFDAF2DCF707079F8F","1698C53EBC888758570396E0334965C1"]},"fields":["firmographics","spend","technographics"],"filters":{"spend":{"categories":{"ids":["319D067B229178F03BCFA1DA4AC4DEDE"]}},"technographics":{"product_attributes":{"ids":[222]},"product_categories":{"ids":["319D067B229178F03BCFA"]},"product_last_verified_date":{"max":"2024-12-31","min":"2024-01-01"},"products":{"ids":[814]},"vendors":{"ids":[316]}}},"pagination":{"technographics":{"limit":25,"offset":0,"sort":"last_seen"}}},"properties":{"companies":{"$ref":"#/components/schemas/CompaniesFilter"},"contracts":{"$ref":"#/components/schemas/ContractsSubBody"},"fields":{"description":"Which data categories to include in the response","items":{"$ref":"#/components/schemas/FieldGroups"},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"filters":{"$ref":"#/components/schemas/EnrichFilters"},"pagination":{"$ref":"#/components/schemas/RequestPagination"}},"required":["companies","fields"],"title":"CompaniesEnrichRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Request","x-validate":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Request"}},"components/schemas/ContractSearchV2DateRange":{"id":"components/schemas/ContractSearchV2DateRange","kind":"json-schema","title":"ContractSearchV2DateRange","data":{"additionalProperties":false,"description":"Date range filter with optional min and max bounds.","properties":{"max":{"description":"Maximum date (inclusive, ISO 8601)","format":"date","type":"string","x-struct":null,"x-validate":null},"min":{"description":"Minimum date (inclusive, ISO 8601)","format":"date","type":"string","x-struct":null,"x-validate":null}},"title":"ContractSearchV2DateRange","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contracts.Search.DateRange","x-validate":null}},"components/schemas/SpendFilters":{"id":"components/schemas/SpendFilters","kind":"json-schema","title":"SpendFilters","data":{"additionalProperties":false,"description":"Filters for spend data","example":{"categories":{"ids":["32144E4D868532F1D3A1264DE832ED2F"],"names":["Cloud"]}},"properties":{"categories":{"$ref":"#/components/schemas/IdFilter"}},"title":"SpendFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.SpendFilters","x-validate":null}},"components/schemas/CompanyFilter":{"id":"components/schemas/CompanyFilter","kind":"json-schema","title":"CompanyFilter","data":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company identifier. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"domain":"microsoft.com"},"properties":{"domain":{"description":"Company domain","example":"microsoft.com","type":"string","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/HexId"}},"title":"CompanyFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.CompanyFilter","x-validate":"Elixir.TalariaWeb.Schemas.V2.CompanyFilter"}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Mentions.Full":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Mentions.Full","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Mentions.Full","data":{"description":"Mention data for a company","properties":{"country_code":{"description":"Country code (when granularity is country)","nullable":true,"type":"string","x-struct":null,"x-validate":null},"first_verified_date":{"description":"First verified date","format":"date","type":"string","x-struct":null,"x-validate":null},"intensity":{"description":"Mention intensity (distinct days detected)","type":"integer","x-struct":null,"x-validate":null},"last_verified_date":{"description":"Last verified date","format":"date","type":"string","x-struct":null,"x-validate":null},"mention_attribute_ids":{"description":"Mention attribute IDs","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"mention_attributes":{"description":"Mention attribute names","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"mention_category_id":{"description":"Mention category ID (hex-encoded)","type":"string","x-struct":null,"x-validate":null},"mention_category_name":{"description":"Mention category name","type":"string","x-struct":null,"x-validate":null},"mention_description":{"description":"Mention product description","type":"string","x-struct":null,"x-validate":null},"mention_id":{"description":"Mention product ID","type":"integer","x-struct":null,"x-validate":null},"mention_name":{"description":"Mention product name","type":"string","x-struct":null,"x-validate":null},"mention_recency":{"description":"Mention recency signal","type":"integer","x-struct":null,"x-validate":null}},"title":"TalariaWeb.Schemas.V2.Companies.Enrich.Mentions.Full","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Mentions.Full","x-validate":null}},"components/schemas/CompanySearchV2FirmographicFilters":{"id":"components/schemas/CompanySearchV2FirmographicFilters","kind":"json-schema","title":"CompanySearchV2FirmographicFilters","data":{"additionalProperties":false,"description":"Firmographic based filters for companies.","example":{"company_level":"CORPORATE_PARENT","country_codes":[{"ids":["US"],"inclusion_method":"ANY_PRESENT"}],"employees":{"has_fixed_employees":true,"max":2500000,"min":1500000},"industries":[{"ids":[16],"inclusion_method":"ANY_PRESENT"}],"naics_codes":[{"codes":["5221","5222"],"inclusion_method":"ANY_PRESENT"}],"region_names":{"ids":["AMER"],"inclusion_method":"ANY_PRESENT"},"revenue":{"has_fixed_revenue":true,"max":700000000000,"min":600000000000},"sic_codes":[{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"NONE_PRESENT"}]},"properties":{"company_level":{"default":"ALL_ENTITIES","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by corporate hierarchy level. ALL_ENTITIES returns all companies (default). CORPORATE_PARENT limits to corporate parents. DOMESTIC_PARENT limits to domestic parents. GLOBAL_HEADQUARTER limits to global headquarters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set, this takes precedence over the deprecated boolean filters in corporate_hierarchy."},"children":[]}]}]}],"enum":["ALL_ENTITIES","CORPORATE_PARENT","DOMESTIC_PARENT","GLOBAL_HEADQUARTER"],"type":"string","x-struct":null,"x-validate":null},"country_codes":{"$ref":"#/components/schemas/CountryCodesFilter"},"employees":{"$ref":"#/components/schemas/CompanySearchV2EmployeesFilter"},"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},"naics_codes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by NAICS (North American Industry Classification System) codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepts either a list of hex-encoded HG Insights derived identifiers ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a list of standard"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NAICS code strings ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", e.g. \"5221\"), along with an inclusion method specifying whether companies"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"should be included or excluded from the results. Each entry must provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":[{"codes":["5221","5222"],"inclusion_method":"ANY_PRESENT"}],"items":{"$ref":"#/components/schemas/AnyNoneCodeOrIdInclusionFilter"},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"region_names":{"$ref":"#/components/schemas/AnyNameInclusionFilter"},"revenue":{"$ref":"#/components/schemas/CompanySearchV2RevenueFilter"},"sic_codes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by SIC (Standard Industrial Classification) codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepts either a list of hex-encoded HG Insights derived identifiers ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a list of standard"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIC code strings ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", e.g. \"5912\"), along with an inclusion method specifying whether companies"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"should be included or excluded from the results. Each entry must provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":[{"codes":["5912"],"inclusion_method":"NONE_PRESENT"}],"items":{"$ref":"#/components/schemas/AnyNoneCodeOrIdInclusionFilter"},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"state_ids":{"$ref":"#/components/schemas/AnyIdInclusionFilter"}},"title":"CompanySearchV2FirmographicFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.Firmographics","x-validate":null}},"components/schemas/EmployeeSummary":{"id":"components/schemas/EmployeeSummary","kind":"json-schema","title":"EmployeeSummary","data":{"description":"Summary statistics for organization employees","nullable":true,"properties":{"decision_makers_identified":{"description":"Number of decision makers identified","minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"departments_mapped":{"description":"Number of departments identified","minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"total_local_employees":{"description":"Total employees at this location","minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null}},"title":"EmployeeSummary","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Statistics.EmployeeSummary","x-validate":null}},"components/schemas/V2Product":{"id":"components/schemas/V2Product","kind":"json-schema","title":"V2Product","data":{"description":"Product schema","example":{"category":{"id":"63E88D6A88D45AB23B4CB4E71CB5A2E"},"description":"Foo bar is an amazing product!","id":32,"name":"Foo Bar","vendor":{"id":493}},"properties":{"category":{"properties":{"id":{"$ref":"#/components/schemas/Id"}},"required":["id"],"type":"object","x-struct":null,"x-validate":null},"description":{"description":"Product description","type":"string","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"Product name","type":"string","x-struct":null,"x-validate":null},"vendor":{"properties":{"id":{"$ref":"#/components/schemas/Id"}},"required":["id"],"type":"object","x-struct":null,"x-validate":null}},"required":["description","id","name","vendor","category"],"title":"V2Product","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.Product","x-validate":null}},"components/schemas/InclusionMethod":{"id":"components/schemas/InclusionMethod","kind":"json-schema","title":"InclusionMethod","data":{"description":"Inclusion method","enum":["ANY_PRESENT","ALL_PRESENT","NONE_PRESENT"],"title":"InclusionMethod","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.InclusionMethod","x-validate":null}},"components/schemas/V2NAICS2012Response":{"id":"components/schemas/V2NAICS2012Response","kind":"json-schema","title":"V2NAICS2012Response","data":{"description":"Response schema for NAICS 2012","example":{"count":1,"data":[{"code":"33636","id":"3FCEDF144BE9F3DFF1145DB6C515FB34","name":"Foo Bar","parent_id":"264DD858DB942CAD06F24FF25DF56716"}]},"properties":{"count":{"description":"Record count","type":"integer","x-struct":null,"x-validate":null},"data":{"items":{"$ref":"#/components/schemas/V2NAICS2012"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2NAICS2012Response","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.Naics2012Response","x-validate":null}},"components/schemas/ContactsEnrichResponse":{"id":"components/schemas/ContactsEnrichResponse","kind":"json-schema","title":"ContactsEnrichResponse","data":{"example":{"contacts":[{"company_id":"02F00022696877390B077DE05D7918CA","company_name":"AppNexus","email":"jane.doe@example.com","email_status":"Unverified","first_name":"Jane","full_name":"Jane Doe","id":"820b11e9bff6183dbefdf3d29c16202f85fe366f7569d0ca0ddfc7e10d372451","last_name":"Doe","linkedin_url":"https://www.linkedin.com/in/jane-doe-820b11e9","phone":"+15550000000","status":"enriched"},{"company_id":"02F00022696877390B077DE05D7918CA","company_name":"AppNexus","id":"5f09a1f4b151848e12aa9fbfa1884ea0e5b6a35a6bb280ca88049529c6ecfbd4","status":"not_found"},{"company_id":"02F00022696877390B077DE05D7918CA","company_name":"AppNexus","id":"37ba3e25df4e4904df7d9794e327012ce66fc6d21ba57d33ebc614719a76edc9","status":"missing_pii"}]},"properties":{"contacts":{"items":{"$ref":"#/components/schemas/ContactsEnrichResult"},"type":"array","x-struct":null,"x-validate":null}},"required":["contacts"],"title":"ContactsEnrichResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contacts.Enrich.Response","x-validate":null}},"components/schemas/CompaniesEnrichEstimateResponse":{"id":"components/schemas/CompaniesEnrichEstimateResponse","kind":"json-schema","title":"CompaniesEnrichEstimateResponse","data":{"properties":{"available_credits":{"description":"Remaining credits in cycle","type":"integer","x-struct":null,"x-validate":null},"credits_estimate":{"description":"Max credits that will be consumed","format":"double","type":"number","x-struct":null,"x-validate":null},"details":{"description":"Per-data-type breakdown (only includes requested field groups)","properties":{"ai_maturity":{"$ref":"#/components/schemas/DataTypeEstimateDetail"},"ai_spend":{"$ref":"#/components/schemas/DataTypeEstimateDetail"},"contracts":{"$ref":"#/components/schemas/DataTypeEstimateDetail"},"firmographics":{"$ref":"#/components/schemas/DataTypeEstimateDetail"},"mentions":{"$ref":"#/components/schemas/DataTypeEstimateDetail"},"spend":{"$ref":"#/components/schemas/DataTypeEstimateDetail"},"technographics":{"$ref":"#/components/schemas/DataTypeEstimateDetail"}},"type":"object","x-struct":null,"x-validate":null},"sufficient_credits":{"description":"Whether org has enough credits","type":"boolean","x-struct":null,"x-validate":null}},"required":["credits_estimate","available_credits","sufficient_credits","details"],"title":"CompaniesEnrichEstimateResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.EstimateResponse","x-validate":null}},"components/schemas/CompanyInstallsCountryFilter":{"id":"components/schemas/CompanyInstallsCountryFilter","kind":"json-schema","title":"CompanyInstallsCountryFilter","data":{"additionalProperties":false,"description":"Filter by the install's own country, independent of the company's location.","example":{"codes":["US"]},"properties":{"codes":{"description":"Array of ISO 3166-1 alpha-2 country codes (e.g., US, GB, DE)","items":{"maxLength":2,"minLength":2,"type":"string","x-struct":null,"x-validate":null},"maxItems":249,"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"title":"CompanyInstallsCountryFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.Installs.CountryFilter","x-validate":null}},"components/schemas/ContactsEnrichRequest":{"id":"components/schemas/ContactsEnrichRequest","kind":"json-schema","title":"ContactsEnrichRequest","data":{"additionalProperties":false,"example":{"fields":["email","phone"],"ids":["820b11e9bff6183dbefdf3d29c16202f85fe366f7569d0ca0ddfc7e10d372451","5f09a1f4b151848e12aa9fbfa1884ea0e5b6a35a6bb280ca88049529c6ecfbd4","37ba3e25df4e4904df7d9794e327012ce66fc6d21ba57d33ebc614719a76edc9"]},"properties":{"fields":{"description":"Fields to enrich for each contact.","items":{"enum":["email","phone"],"type":"string","x-struct":null,"x-validate":null},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"ids":{"description":"List of contact IDs to enrich. A maximum of 20 IDs may be enriched per request.","items":{"description":"A contact ID (hexadecimal hash key).","example":"820b11e9bff6183dbefdf3d29c16202f85fe366f7569d0ca0ddfc7e10d372451","type":"string","x-struct":null,"x-validate":null},"maxItems":20,"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"required":["ids","fields"],"title":"ContactsEnrichRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contacts.Enrich.Request","x-validate":null}},"components/schemas/ContractSearchEstimateResponse":{"id":"components/schemas/ContractSearchEstimateResponse","kind":"json-schema","title":"ContractSearchEstimateResponse","data":{"description":"Estimated credit cost for a contract search request.","example":{"available_credits":1000,"credits_estimate":25,"sufficient_credits":true},"properties":{"available_credits":{"description":"Credits currently available to the organization","type":"integer","x-struct":null,"x-validate":null},"credits_estimate":{"description":"Estimated credits required to fulfill the request","format":"double","type":"number","x-struct":null,"x-validate":null},"sufficient_credits":{"description":"Whether available credits cover the estimate","type":"boolean","x-struct":null,"x-validate":null}},"required":["credits_estimate","available_credits","sufficient_credits"],"title":"ContractSearchEstimateResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contracts.Search.EstimateResponse","x-validate":null}},"components/schemas/HierarchyFilters":{"id":"components/schemas/HierarchyFilters","kind":"json-schema","title":"HierarchyFilters","data":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional filters applied to the hierarchy results. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tiers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" require "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format: list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and are rejected with HTTP 400 ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FILTER_NOT_VALID_FOR_TREE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") when used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format: tree"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_tier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" works with both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tree"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"countries":["BR"],"regions":["EMEA"]},"properties":{"countries":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrict results to companies in these ISO-3166-1 alpha-2 country codes. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format: list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not supported with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format: tree"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"items":{"maxLength":2,"minLength":2,"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"max_tier":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrict results to companies at or above this hierarchy tier. Works with both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tree"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" formats; use it to limit tree depth."},"children":[]}]}]}],"enum":["group_hq","corporate_parent","domestic_parent","subsidiary"],"type":"string","x-struct":null,"x-validate":null},"regions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrict results to companies in these geopolitical regions. Combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using union (OR) semantics. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format: list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not supported with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format: tree"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"items":{"enum":["AMER","EMEA","APAC"],"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"tiers":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrict results to companies at these hierarchy tiers. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format: list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not supported with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format: tree"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"items":{"enum":["group_hq","corporate_parent","domestic_parent","subsidiary"],"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"title":"HierarchyFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Hierarchy.Filters","x-validate":null}},"components/schemas/AliasExpansion":{"id":"components/schemas/AliasExpansion","kind":"json-schema","title":"AliasExpansion","data":{"description":"A colloquial term the server expanded into substring matches.","properties":{"expanded_to":{"description":"Substrings the server actually searched in place of the term.","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"term":{"description":"The colloquial term as supplied by the caller.","type":"string","x-struct":null,"x-validate":null}},"required":["term","expanded_to"],"title":"AliasExpansion","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Industries.Search.AliasExpansion","x-validate":null}},"components/schemas/IntentTopicsFilters":{"id":"components/schemas/IntentTopicsFilters","kind":"json-schema","title":"IntentTopicsFilters","data":{"additionalProperties":false,"description":"Filters that apply only to the topics (HG intent signals) section.","properties":{"buyers_journey_names":{"description":"Filter by buyer's journey names (HG topics only)","example":["Evaluating"],"items":{"enum":["Evaluating","Researching"],"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"context_type_names":{"description":"Filter by context type names (HG topics only)","example":["Displacement"],"items":{"enum":["Displacement","Whitespace","Expansion","Complementary"],"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"granularity":{"default":"state","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls row grouping for topics. \"global\" = one row per topic, \"region\" = per topic x region, \"country\" = per topic x country, \"state\" = per topic x state (default, current behavior). At non-state levels, buyers_journey_names (array) is populated and buyers_journey_name is null. location_count replaces location_strength for non-state levels."},"children":[]}]}]}],"enum":["global","region","country","state"],"type":"string","x-struct":null,"x-validate":null},"signal_level":{"description":"Filter by signal level (HG topics only)","example":["HIGH"],"items":{"enum":["HIGH","MEDIUM","LOW"],"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"topic_ids":{"description":"Filter by specific intent topic IDs","example":["1698C53EBC888758570396E0334965C1"],"items":{"$ref":"#/components/schemas/HexId"},"type":"array","x-struct":null,"x-validate":null}},"title":"IntentTopicsFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.TopicsFilters","x-validate":null}},"components/schemas/MentionsTimeSeriesDataPoint":{"id":"components/schemas/MentionsTimeSeriesDataPoint","kind":"json-schema","title":"MentionsTimeSeriesDataPoint","data":{"example":{"date":"2024-01","intensity":72},"properties":{"date":{"description":"YYYY-MM","type":"string","x-struct":null,"x-validate":null},"intensity":{"nullable":true,"type":"integer","x-struct":null,"x-validate":null}},"title":"MentionsTimeSeriesDataPoint","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Mentions.TimeSeries.DataPoint","x-validate":null}},"components/schemas/IntentEstimateResponse":{"id":"components/schemas/IntentEstimateResponse","kind":"json-schema","title":"IntentEstimateResponse","data":{"description":"Estimated credit cost for an intent enrich request.","example":{"available_credits":1000,"credits_estimate":15,"details":{"activities":{"credits":5},"topics":{"credits":10}},"sufficient_credits":true},"properties":{"available_credits":{"description":"Credits currently available to the organization","type":"integer","x-struct":null,"x-validate":null},"credits_estimate":{"description":"Estimated credits required to fulfill the request","format":"double","type":"number","x-struct":null,"x-validate":null},"details":{"description":"Per-section credit breakdown","nullable":true,"properties":{"activities":{"properties":{"credits":{"format":"double","type":"number","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"topics":{"properties":{"credits":{"format":"double","type":"number","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"sufficient_credits":{"description":"Whether available credits cover the estimate","type":"boolean","x-struct":null,"x-validate":null}},"required":["credits_estimate","available_credits","sufficient_credits"],"title":"IntentEstimateResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.EstimateResponse","x-validate":null}},"components/schemas/ContactSearchV2Filters":{"id":"components/schemas/ContactSearchV2Filters","kind":"json-schema","title":"ContactSearchV2Filters","data":{"additionalProperties":false,"description":"Filters object for contact search. All filters are inclusion-only.","example":{"companies":{"ids":["1698C53EBC888758570396E0334965C1"]},"contact_location":{"countries":["US"]},"job_functions":["Engineering"],"job_seniority":["Director"],"time_in_current_role":["company_veteran"]},"properties":{"companies":{"$ref":"#/components/schemas/ContactSearchV2CompaniesFilter"},"contact_location":{"$ref":"#/components/schemas/ContactSearchV2ContactLocationFilter"},"job_functions":{"description":"Filter by job function. Inclusion only.","items":{"type":"string","x-struct":null,"x-validate":null},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"job_seniority":{"description":"Filter by job seniority. Inclusion only.","items":{"type":"string","x-struct":null,"x-validate":null},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"time_in_current_role":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by time in current role. Inclusion only."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum values:"},"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":"code","inline":true,"attributes":{"content":"new_change_maker"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": New Change-Maker (< 6 months)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rising_contributor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Rising Contributor (6 months - 1 year)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"established_performer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Established Performer (1-2 years)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stable_operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Stable Operator (3-5 years)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_veteran"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Company Veteran (5+ years)"},"children":[]}]}]}]}],"items":{"enum":["company_veteran","stable_operator","established_performer","new_change_maker","rising_contributor"],"type":"string","x-struct":null,"x-validate":null},"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"title":"ContactSearchV2Filters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contacts.Search.Filters","x-validate":null}},"components/schemas/IndustrySearchResult":{"id":"components/schemas/IndustrySearchResult","kind":"json-schema","title":"IndustrySearchResult","data":{"description":"One crosswalk row, plus which taxonomy field produced the hit.","properties":{"industry":{"$ref":"#/components/schemas/IndustryMapping"},"matched_on":{"$ref":"#/components/schemas/TaxonomyType"},"naics":{"$ref":"#/components/schemas/NaicsMapping"},"sic":{"$ref":"#/components/schemas/SicMapping"}},"required":["matched_on","industry","naics","sic"],"title":"IndustrySearchResult","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Industries.Search.IndustrySearchResult","x-validate":null}},"components/schemas/MentionsTimeSeriesRequest":{"id":"components/schemas/MentionsTimeSeriesRequest","kind":"json-schema","title":"MentionsTimeSeriesRequest","data":{"additionalProperties":false,"description":"Single-company mentions time series. Returns monthly intensity per mention with dense arrays for charting.","example":{"company":{"domain":"walmart.com"},"filters":{"mentions":{"ids":[100]}},"max_mentions":20,"time_range":{"relative_range":"last_24m"}},"properties":{"company":{"$ref":"#/components/schemas/CompanyFilter"},"filters":{"$ref":"#/components/schemas/MentionsTimeSeriesFilters"},"max_mentions":{"default":20,"maximum":50,"minimum":1,"type":"integer","x-struct":null,"x-validate":null},"time_range":{"$ref":"#/components/schemas/TimeSeriesRange"}},"required":["company"],"title":"MentionsTimeSeriesRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Mentions.TimeSeries.Request","x-validate":null}},"components/schemas/CompanySearchV2SignedRangeFilter":{"id":"components/schemas/CompanySearchV2SignedRangeFilter","kind":"json-schema","title":"CompanySearchV2SignedRangeFilter","data":{"additionalProperties":false,"description":"Range filter object allowing negative bounds. At least one of min or max is required. When both are provided, min must be less than or equal to max.","example":{"max":0,"min":-100},"minProperties":1,"properties":{"max":{"description":"Maximum value (may be negative)","type":"integer","x-struct":null,"x-validate":null},"min":{"description":"Minimum value (may be negative)","type":"integer","x-struct":null,"x-validate":null}},"title":"CompanySearchV2SignedRangeFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.SignedRangeFilter","x-validate":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.SignedRangeFilter"}},"components/schemas/V2SpendCategory":{"id":"components/schemas/V2SpendCategory","kind":"json-schema","title":"V2SpendCategory","data":{"description":"Spend category schema","example":{"export_name":"export_foo_bar","id":"5D8B4B61BA2C56471268612D83903B6","name":"Application Led Outsourcing","name_tree":["Total IT","Total External IT","Services","Application Led Outsourcing"],"parent_id":"1DF1C16E82351BD6ABC74D230191CD1E"},"properties":{"export_name":{"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},"name_tree":{"description":"Spend category name tree","items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"parent_id":{"description":"Spend category parent ID","type":"string","x-struct":null,"x-validate":null}},"required":["id","name","export_name","name_tree","parent_id"],"title":"V2SpendCategory","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.SpendCategory","x-validate":null}},"components/schemas/MentionsTimeSeriesMention":{"id":"components/schemas/MentionsTimeSeriesMention","kind":"json-schema","title":"MentionsTimeSeriesMention","data":{"example":{"current_intensity":72,"data_points":[{"date":"2024-01","intensity":45},{"date":"2024-02","intensity":null},{"date":"2024-03","intensity":51},{"date":"2024-04","intensity":72}],"is_active":true,"mention_category_name":"Container Orchestration","mention_id":100,"mention_name":"Kubernetes"},"properties":{"country_code":{"description":"ISO 3166-1 alpha-2 country code. Populated when granularity is :country, null when :global.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"current_intensity":{"type":"integer","x-struct":null,"x-validate":null},"data_points":{"items":{"$ref":"#/components/schemas/MentionsTimeSeriesDataPoint"},"type":"array","x-struct":null,"x-validate":null},"is_active":{"type":"boolean","x-struct":null,"x-validate":null},"mention_category_name":{"type":"string","x-struct":null,"x-validate":null},"mention_id":{"type":"integer","x-struct":null,"x-validate":null},"mention_name":{"type":"string","x-struct":null,"x-validate":null}},"title":"MentionsTimeSeriesMention","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Mentions.TimeSeries.MentionResult","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":{"context_type_ids":{"ids":["DEF456789012345678901234ABCDEF12"],"inclusion_method":"ANY_PRESENT"},"location":{"country_alpha2s":[{"ids":["US","CA"],"inclusion_method":"ANY_PRESENT"}]},"signal_score":"MEDIUM","topics":{"ids":["19861D3AC60455102792F87A33AF533F"],"inclusion_method":"ANY_PRESENT"}},"minProperties":1,"properties":{"buyers_journey_ids":{"$ref":"#/components/schemas/IdInclusionFilter"},"context_type_ids":{"$ref":"#/components/schemas/IdInclusionFilter"},"location":{"$ref":"#/components/schemas/IntentLocationFilter"},"number_of_cadences":{"description":"Number of cadences","minimum":1,"type":"integer","x-struct":null,"x-validate":null},"signal_score":{"$ref":"#/components/schemas/IntentSignalScoreFilter"},"topics":{"$ref":"#/components/schemas/IntentTopicsFilter"}},"title":"CompanyFiltersIntent","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.Intent","x-validate":null}},"components/schemas/StatisticsContractSummary":{"id":"components/schemas/StatisticsContractSummary","kind":"json-schema","title":"StatisticsContractSummary","data":{"description":"Summary statistics for a company's contracts","nullable":true,"properties":{"average_contract_length_months":{"description":"Average contract length in months","minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"average_contract_value":{"description":"Average contract value","minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"total_active_contracts":{"description":"Total active contracts","minimum":0,"type":"integer","x-struct":null,"x-validate":null},"total_contract_value":{"description":"Total value of all contracts","minimum":0,"nullable":true,"type":"integer","x-struct":null,"x-validate":null},"upcoming_renewals_30d":{"description":"Contracts renewing in next 30 days","minimum":0,"type":"integer","x-struct":null,"x-validate":null},"upcoming_renewals_90d":{"description":"Contracts renewing in next 90 days","minimum":0,"type":"integer","x-struct":null,"x-validate":null}},"title":"StatisticsContractSummary","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Statistics.ContractSummary","x-validate":null}},"components/schemas/CompanySearchV2Sort":{"id":"components/schemas/CompanySearchV2Sort","kind":"json-schema","title":"CompanySearchV2Sort","data":{"additionalProperties":false,"description":"A sort object for company search results","example":{"direction":"ASC","field":"name"},"properties":{"direction":{"$ref":"#/components/schemas/CompanySearchV2SortDirection"},"field":{"$ref":"#/components/schemas/CompanySearchV2SortFieldNames"}},"required":["field","direction"],"title":"CompanySearchV2Sort","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Search.Sort","x-validate":null}},"components/schemas/V2Industry":{"id":"components/schemas/V2Industry","kind":"json-schema","title":"V2Industry","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":"V2Industry","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.Industry","x-validate":null}},"components/schemas/IntentSummary":{"id":"components/schemas/IntentSummary","kind":"json-schema","title":"IntentSummary","data":{"description":"Aggregate summary computed from the fetched signals.","properties":{"active_topics_count":{"description":"Number of HG topics with active signals","type":"integer","x-struct":null,"x-validate":null},"high_signal_topics_count":{"description":"Number of HG topics with HIGH signal level","type":"integer","x-struct":null,"x-validate":null},"latest_signal_date":{"description":"Most recent signal date across both sources","format":"date","nullable":true,"type":"string","x-struct":null,"x-validate":null},"sources":{"additionalProperties":{"type":"integer","x-struct":null,"x-validate":null},"description":"Count of signals per source (HG, TRUSTRADIUS)","type":"object","x-struct":null,"x-validate":null},"top_context_types":{"additionalProperties":{"type":"integer","x-struct":null,"x-validate":null},"description":"Frequency of top context types","type":"object","x-struct":null,"x-validate":null}},"title":"IntentSummary","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.Summary","x-validate":null}},"components/schemas/V2State":{"id":"components/schemas/V2State","kind":"json-schema","title":"V2State","data":{"description":"State schema","example":{"country":{"code":"FR"},"id":"AEA8D2254D475DED13FD3F4339C6B8G","name":"Île-de-France"},"properties":{"country":{"properties":{"code":{"description":"Country code (alpha-2)","type":"string","x-struct":null,"x-validate":null}},"required":["code"],"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":"V2State","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.State","x-validate":null}},"components/schemas/CompaniesEnrichResponse":{"id":"components/schemas/CompaniesEnrichResponse","kind":"json-schema","title":"CompaniesEnrichResponse","data":{"description":"Response containing enriched company data","example":{"companies":[{"domain":"cisco.com","firmographics":{"country_code":"US","domain":"cisco.com","name":"Cisco Systems, Inc."},"id":"1698C53EBC888758570396E0334965C1"},{"domain":"lehlvksjbdvsdf.com","id":null}]},"properties":{"companies":{"items":{"$ref":"#/components/schemas/CompanyEnrichObject"},"type":"array","x-struct":null,"x-validate":null}},"title":"CompaniesEnrichResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Response","x-validate":null}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Basic":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Basic","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Basic","data":{"description":"Technology install/usage basic data","properties":{"country_code":{"nullable":true,"type":"string","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_id":{"type":"integer","x-struct":null,"x-validate":null},"product_last_verified_date":{"format":"date-time","type":"string","x-struct":null,"x-validate":null},"product_name":{"type":"string","x-struct":null,"x-validate":null},"vendor_domain":{"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":"TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Basic","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Technographics.Basic","x-validate":null}},"components/schemas/CompanySearchV2SortDirection":{"id":"components/schemas/CompanySearchV2SortDirection","kind":"json-schema","title":"CompanySearchV2SortDirection","data":{"default":"ASC","description":"Sort direction","enum":["ASC","DESC"],"title":"CompanySearchV2SortDirection","type":"string","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Search.SortDirection","x-validate":null}},"components/schemas/ContactsEnrichResult":{"id":"components/schemas/ContactsEnrichResult","kind":"json-schema","title":"ContactsEnrichResult","data":{"example":{"company_id":"02F00022696877390B077DE05D7918CA","company_name":"AppNexus","email":"jane.doe@example.com","email_status":"Unverified","first_name":"Jane","full_name":"Jane Doe","id":"820b11e9bff6183dbefdf3d29c16202f85fe366f7569d0ca0ddfc7e10d372451","last_name":"Doe","linkedin_url":"https://www.linkedin.com/in/jane-doe-820b11e9","phone":"+15550000000","status":"enriched"},"properties":{"company_id":{"description":"The ID of the contact's company.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"company_name":{"description":"The name of the contact's company.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"email":{"description":"The enriched email address.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"email_status":{"description":"The deliverability status of the email.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"first_name":{"description":"The contact's first name.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"full_name":{"description":"The contact's full name.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"id":{"description":"The contact ID.","type":"string","x-struct":null,"x-validate":null},"last_name":{"description":"The contact's last name.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"linkedin_url":{"description":"The contact's LinkedIn profile URL.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"phone":{"description":"The enriched phone number.","nullable":true,"type":"string","x-struct":null,"x-validate":null},"status":{"description":"The enrichment status for the contact.","enum":["enriched","not_found","missing_pii"],"type":"string","x-struct":null,"x-validate":null}},"required":["id","status"],"title":"ContactsEnrichResult","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contacts.Enrich.ContactResult","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/TechnographicsTimeSeriesRequest":{"id":"components/schemas/TechnographicsTimeSeriesRequest","kind":"json-schema","title":"TechnographicsTimeSeriesRequest","data":{"additionalProperties":false,"description":"Single-company technographics time series. Returns monthly intensity per product with dense arrays for charting.","example":{"company":{"domain":"walmart.com"},"filters":{"vendors":{"ids":[376]}},"max_products":20,"time_range":{"relative_range":"last_24m"}},"properties":{"company":{"$ref":"#/components/schemas/CompanyFilter"},"filters":{"$ref":"#/components/schemas/TechnographicsTimeSeriesFilters"},"max_products":{"default":20,"maximum":50,"minimum":1,"type":"integer","x-struct":null,"x-validate":null},"time_range":{"$ref":"#/components/schemas/TimeSeriesRange"}},"required":["company"],"title":"TechnographicsTimeSeriesRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Technographics.TimeSeries.Request","x-validate":null}},"components/schemas/CompaniesSearchRequest":{"id":"components/schemas/CompaniesSearchRequest","kind":"json-schema","title":"CompaniesSearchRequest","data":{"additionalProperties":false,"description":"Search and filter companies. Returns paginated matching companies.","example":{"fields":["id","name","domain"],"filters":{"company_identifiers":{"company_ids":{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"ANY_PRESENT"}},"firmographics":{"company_level":"CORPORATE_PARENT","country_codes":[{"ids":["US"],"inclusion_method":"ANY_PRESENT"}],"employees":{"has_fixed_employees":true,"min":1000},"industries":[{"ids":[16],"inclusion_method":"ANY_PRESENT"}],"revenue":{"has_fixed_revenue":true,"min":10000000}},"installs":{"products":[{"ids":[814],"inclusion_method":"ANY_PRESENT"}],"vendors":[{"ids":[316],"inclusion_method":"ANY_PRESENT"}]},"spend":[{"categories":{"ids":["3B36D42E7F8E60BE58BA4356B6AF40C"],"inclusion_method":"ANY_PRESENT"},"range":{"min":100000}}]},"limit":10,"offset":0,"sorts":[{"direction":"ASC","field":"name"}]},"properties":{"fields":{"description":"Fields to include in the response. At least one field is required.","example":["id","name","domain","domain_normalized"],"items":{"$ref":"#/components/schemas/CompanySearchV2FieldNames"},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"filters":{"$ref":"#/components/schemas/CompanySearchV2Filters"},"limit":{"default":10,"description":"Maximum number of companies to return","maximum":100,"minimum":1,"type":"integer","x-struct":null,"x-validate":null},"offset":{"default":0,"description":"Number of companies to skip (max 24,999)","maximum":24999,"minimum":0,"type":"integer","x-struct":null,"x-validate":null},"sorts":{"$ref":"#/components/schemas/CompanySearchV2Sorts"}},"required":["fields","filters"],"title":"CompaniesSearchRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Search.Request","x-validate":"Elixir.TalariaWeb.Schemas.V2.Companies.Search.Request"}},"components/schemas/ProductCategoriesFilter":{"id":"components/schemas/ProductCategoriesFilter","kind":"json-schema","title":"ProductCategoriesFilter","data":{"description":"Filter based on the product category an install record is classified under, with optional FAI and install age sub-filters.","example":{"ids":["319D067B229178F03BCFA1DA4AC4DEDE"],"inclusion_method":"ANY_PRESENT","install_age":{"max":12}},"properties":{"fai":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Functional Area Intelligence filter — at least one of departments or roles required"},"children":[]}]}]}],"minProperties":1,"properties":{"departments":{"$ref":"#/components/schemas/IdInclusionFilter"},"roles":{"$ref":"#/components/schemas/IdInclusionFilter"}},"type":"object","x-struct":null,"x-validate":null},"ids":{"description":"Product Category IDs (hex encoded)","items":{"$ref":"#/components/schemas/Id"},"minItems":1,"type":"array","x-struct":null,"x-validate":null},"inclusion_method":{"$ref":"#/components/schemas/InclusionMethod"},"install_age":{"$ref":"#/components/schemas/RangeFilter"},"install_age_months":{"$ref":"#/components/schemas/RangeFilter"}},"required":["ids","inclusion_method"],"title":"ProductCategoriesFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Company.Filters.Installs.ProductCategoriesFilter","x-validate":null}},"components/schemas/SignalDateFilter":{"id":"components/schemas/SignalDateFilter","kind":"json-schema","title":"SignalDateFilter","data":{"additionalProperties":false,"description":"Filter by signal date range (inclusive).","example":{"max":"2026-12-31","min":"2023-01-01"},"properties":{"max":{"description":"Only include signals on or before this date (inclusive), e.g. 2026-12-31","format":"date","type":"string","x-struct":null,"x-validate":null},"min":{"description":"Only include signals on or after this date (inclusive), e.g. 2023-01-01","format":"date","type":"string","x-struct":null,"x-validate":null}},"title":"SignalDateFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.SignalDateFilter","x-validate":"Elixir.TalariaWeb.Schemas.V2.Intent.Enrich.SignalDateFilter"}},"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":25,"title":"Limit","type":"integer","x-struct":"Elixir.TalariaWeb.Schemas.V2.Pagination.Limit","x-validate":null}},"components/schemas/MentionsTimeSeriesFilters":{"id":"components/schemas/MentionsTimeSeriesFilters","kind":"json-schema","title":"MentionsTimeSeriesFilters","data":{"additionalProperties":false,"example":{"mentions":{"ids":[100]}},"properties":{"categories":{"additionalProperties":false,"properties":{"ids":{"items":{"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"country":{"additionalProperties":false,"properties":{"codes":{"description":"ISO 3166-1 alpha-2 country codes to filter by","items":{"maxLength":2,"minLength":2,"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"granularity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\":country\" returns one entry per mention per country with country_code populated. \":global\" returns deduplicated entries per mention with country_code null. Defaults to \":global\"."},"children":[]}]}]}],"enum":["global","country"],"type":"string","x-struct":null,"x-validate":null},"mentions":{"additionalProperties":false,"properties":{"ids":{"items":{"type":"integer","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null}},"title":"MentionsTimeSeriesFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Mentions.TimeSeries.Filters","x-validate":null}},"components/schemas/SpendPagination":{"id":"components/schemas/SpendPagination","kind":"json-schema","title":"SpendPagination","data":{"additionalProperties":false,"description":"Pagination parameters for spend data. Set paginate to false to return all categories without pagination (limit and offset are ignored).","properties":{"limit":{"$ref":"#/components/schemas/Limit"},"offset":{"$ref":"#/components/schemas/Offset"},"paginate":{"default":true,"description":"When false, returns all spend categories without pagination. The limit and offset parameters are ignored.","type":"boolean","x-struct":null,"x-validate":null}},"title":"SpendPagination","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.SpendPagination","x-validate":null}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.AiMaturity":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.AiMaturity","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.AiMaturity","data":{"allOf":[{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.AiMaturity.Full"}],"description":"AI maturity data for a company","title":"TalariaWeb.Schemas.V2.Companies.Enrich.AiMaturity","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.AiMaturity","x-validate":null}},"components/schemas/ContactSearchV2ContactLocationFilter":{"id":"components/schemas/ContactSearchV2ContactLocationFilter","kind":"json-schema","title":"ContactSearchV2ContactLocationFilter","data":{"additionalProperties":false,"description":"Filter contacts by location.","example":{"countries":["US","CA"]},"properties":{"countries":{"description":"List of ISO 3166-1 alpha-2 country codes.","items":{"type":"string","x-struct":null,"x-validate":null},"minItems":1,"type":"array","x-struct":null,"x-validate":null}},"title":"ContactSearchV2ContactLocationFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contacts.Search.ContactLocationFilter","x-validate":null}},"components/schemas/AnyNoneCodeInclusionFilter":{"id":"components/schemas/AnyNoneCodeInclusionFilter","kind":"json-schema","title":"AnyNoneCodeInclusionFilter","data":{"additionalProperties":false,"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 standard code strings. Can filter codes by ANY_PRESENT or NONE_PRESENT inclusion methods"},"children":[]}]}]}],"example":{"codes":["5221","5222"],"inclusion_method":"ANY_PRESENT"},"properties":{"codes":{"description":"Standard code strings","items":{"minLength":1,"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":["codes","inclusion_method"],"title":"AnyNoneCodeInclusionFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V1.Filters.AnyNoneCodeInclusionFilter","x-validate":null}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Full":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Full","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Full","data":{"allOf":[{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Basic"},{"$ref":"#/components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Premium"}],"description":"Full technology install/usage data","title":"TalariaWeb.Schemas.V2.Companies.Enrich.Technographics.Full","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.Technographics.Full","x-validate":null}},"components/schemas/V2IntentTopicsResponse":{"id":"components/schemas/V2IntentTopicsResponse","kind":"json-schema","title":"V2IntentTopicsResponse","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/V2IntentTopic"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2IntentTopicsResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.IntentTopicsResponse","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.V2.Pagination.Offset","x-validate":null}},"components/schemas/InstallsFilter":{"id":"components/schemas/InstallsFilter","kind":"json-schema","title":"InstallsFilter","data":{"additionalProperties":false,"description":"Install-level filter options","properties":{"granularity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls the shape of returned installs. \"country\" returns one row per product per country with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" populated (across all countries the company has installs in, unless restricted by the country code filter). \"global\" returns deduplicated rows per product with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" null. When omitted, behavior falls back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"localized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"localized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when provided."},"children":[]}]}]}],"enum":["global","country"],"type":"string","x-struct":null,"x-validate":null},"localized":{"default":true,"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"granularity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Only match records where installs are within the same country as the company. Overridden by country code filter when provided. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"granularity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, it takes precedence over this field."},"children":[]}]}]}],"type":"boolean","x-struct":null,"x-validate":null}},"title":"InstallsFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.TechnographicsFilters.InstallsFilter","x-validate":null}},"components/schemas/CompanySearchV2InstallsFilters":{"id":"components/schemas/CompanySearchV2InstallsFilters","kind":"json-schema","title":"CompanySearchV2InstallsFilters","data":{"additionalProperties":false,"description":"Filters based around the install records detected at a company.","example":{"country":{"codes":["US"]},"product_attributes":{"ids":[222],"inclusion_method":"ANY_PRESENT","install_age_months":{"max":18,"min":3}},"product_categories":{"ids":["319D067B229178F03BCFA1DA4AC4DEDE"],"inclusion_method":"ANY_PRESENT","install_age":{"max":12}},"product_last_verified_date":{"max":"2024-12-31","min":"2024-01-01"},"products":[{"fai":{"departments":{"ids":["A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"],"inclusion_method":"ANY_PRESENT"}},"ids":[814],"inclusion_method":"ANY_PRESENT","install_age":{"max":24,"min":6}}],"vendors":[{"ids":[316],"inclusion_method":"ANY_PRESENT","product_count":{"min":5}}]},"properties":{"country":{"$ref":"#/components/schemas/CompanyInstallsCountryFilter"},"product_attributes":{"$ref":"#/components/schemas/ProductAttributesFilterCompanyInstalls"},"product_categories":{"$ref":"#/components/schemas/ProductCategoriesFilter"},"product_last_verified_date":{"$ref":"#/components/schemas/CompanyInstallsLastVerifiedDateFilter"},"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":"CompanySearchV2InstallsFilters","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.Installs","x-validate":null}},"components/schemas/CompanySearchV2CloudMaturityFilter":{"id":"components/schemas/CompanySearchV2CloudMaturityFilter","kind":"json-schema","title":"CompanySearchV2CloudMaturityFilter","data":{"additionalProperties":false,"description":"Filter by cloud maturity data fields.","properties":{"aws_products_count":{"$ref":"#/components/schemas/CompanySearchV2RangeFilter"},"azure_products_count":{"$ref":"#/components/schemas/CompanySearchV2RangeFilter"},"cloud_stack_percent_change":{"$ref":"#/components/schemas/CompanySearchV2SignedRangeFilter"},"current_products_used_cloud_percent":{"$ref":"#/components/schemas/CompanySearchV2RangeFilter"},"current_products_used_total_count":{"$ref":"#/components/schemas/CompanySearchV2RangeFilter"},"gcp_products_count":{"$ref":"#/components/schemas/CompanySearchV2RangeFilter"},"new_products_used_cloud_percent":{"$ref":"#/components/schemas/CompanySearchV2RangeFilter"}},"title":"CompanySearchV2CloudMaturityFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Filters.CloudMaturityFilter","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/V2JobFunction":{"id":"components/schemas/V2JobFunction","kind":"json-schema","title":"V2JobFunction","data":{"description":"Job function schema","example":{"name":"Engineering"},"properties":{"name":{"description":"Job function name","type":"string","x-struct":null,"x-validate":null}},"required":["name"],"title":"V2JobFunction","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.JobFunction","x-validate":null}},"components/schemas/V2StatesResponse":{"id":"components/schemas/V2StatesResponse","kind":"json-schema","title":"V2StatesResponse","data":{"description":"Response schema for states","example":{"count":1,"data":[{"country":{"code":"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/V2State"},"type":"array","x-struct":null,"x-validate":null}},"title":"V2StatesResponse","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.StatesResponse","x-validate":null}},"components/schemas/ContractSearchRequest":{"id":"components/schemas/ContractSearchRequest","kind":"json-schema","title":"ContractSearchRequest","data":{"additionalProperties":false,"description":"Search and filter contracts. Returns paginated matching contracts.","example":{"filters":{"company_ids":["1698C53EBC888758570396E0334965C1"]},"limit":10,"offset":0,"sorts":[{"direction":"DESC","field":"end_date"}]},"properties":{"filters":{"$ref":"#/components/schemas/ContractSearchV2Filters"},"global_settings":{"$ref":"#/components/schemas/GlobalSettings"},"limit":{"default":10,"description":"Maximum number of contracts to return","maximum":100,"minimum":1,"type":"integer","x-struct":null,"x-validate":null},"offset":{"default":0,"description":"Number of contracts to skip","minimum":0,"type":"integer","x-struct":null,"x-validate":null},"sorts":{"$ref":"#/components/schemas/ContractSearchV2Sorts"},"tracking_context":{"description":"Tracking context for analytics and auditing","type":"object","x-struct":null,"x-validate":null}},"required":["filters"],"title":"ContractSearchRequest","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Contracts.Search.Request","x-validate":null}},"components/schemas/FunctionalAreasCompanyFilter":{"id":"components/schemas/FunctionalAreasCompanyFilter","kind":"json-schema","title":"FunctionalAreasCompanyFilter","data":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company identifier. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"domain":"microsoft.com"},"properties":{"domain":{"description":"Company domain (e.g. \"microsoft.com\")","example":"microsoft.com","type":"string","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/HexId"}},"title":"FunctionalAreasCompanyFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.FunctionalAreas.CompanyFilter","x-validate":null}},"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.AiMaturity.Full":{"id":"components/schemas/TalariaWeb.Schemas.V2.Companies.Enrich.AiMaturity.Full","kind":"json-schema","title":"TalariaWeb.Schemas.V2.Companies.Enrich.AiMaturity.Full","data":{"description":"AI maturity data for a company","properties":{"ai_maturity_6m_delta":{"description":"6-month score change","format":"float","type":"number","x-struct":null,"x-validate":null},"ai_maturity_rank":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rank by AI maturity score (1 = highest)"},"children":[]}]}]}],"type":"integer","x-struct":null,"x-validate":null},"ai_maturity_score":{"description":"Composite AI maturity score (0-100)","format":"float","type":"number","x-struct":null,"x-validate":null},"ai_product_use":{"description":"Whether company has AI product installed","type":"boolean","x-struct":null,"x-validate":null},"cloud_centricity":{"description":"Dominant cloud provider","nullable":true,"type":"string","x-struct":null,"x-validate":null},"cloud_intensity":{"description":"Cloud intensity scores by provider","properties":{"aws":{"description":"AWS intensity (0-100)","type":"integer","x-struct":null,"x-validate":null},"azure":{"description":"Azure intensity (0-100)","type":"integer","x-struct":null,"x-validate":null},"gcp":{"description":"GCP intensity (0-100)","type":"integer","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"data_maturity_level":{"description":"Data maturity level","enum":["LOW","MEDIUM","HIGH"],"nullable":true,"type":"string","x-struct":null,"x-validate":null},"data_maturity_score":{"description":"Data maturity score (0-100)","format":"float","type":"number","x-struct":null,"x-validate":null},"genai_intent_score":{"description":"GenAI buying intent score","type":"integer","x-struct":null,"x-validate":null}},"title":"TalariaWeb.Schemas.V2.Companies.Enrich.AiMaturity.Full","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.Fields.AiMaturity.Full","x-validate":null}},"components/schemas/StringIdFilter":{"id":"components/schemas/StringIdFilter","kind":"json-schema","title":"StringIdFilter","data":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by string IDs and/or names (assumes ANY_PRESENT inclusion method)"},"children":[]}]}]}],"properties":{"ids":{"description":"Array of string IDs","items":{"minLength":1,"type":"string","x-struct":null,"x-validate":null},"type":"array","x-struct":null,"x-validate":null},"names":{"description":"Array of entity names for substring matching (case-insensitive)","items":{"minLength":1,"type":"string","x-struct":null,"x-validate":null},"maxItems":10,"type":"array","x-struct":null,"x-validate":null}},"title":"StringIdFilter","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.TechnographicsFilters.StringIdFilter","x-validate":"Elixir.TalariaWeb.Schemas.V2.Companies.Enrich.TechnographicsFilters.StringIdFilter"}},"components/schemas/V2Vendor":{"id":"components/schemas/V2Vendor","kind":"json-schema","title":"V2Vendor","data":{"description":"Vendor schema","example":{"domain":"https://vendor.com","id":"10056","name":"Vendor Name"},"properties":{"domain":{"description":"Vendor domain","type":"string","x-struct":null,"x-validate":null},"id":{"$ref":"#/components/schemas/Id"},"name":{"description":"Vendor name","type":"string","x-struct":null,"x-validate":null}},"required":["id","name","domain"],"title":"V2Vendor","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.Vendor","x-validate":null}},"components/schemas/V2NAICS2012":{"id":"components/schemas/V2NAICS2012","kind":"json-schema","title":"V2NAICS2012","data":{"description":"NAICS 2012 schema","example":{"code":"33636","id":"3FCEDF144BE9F3DFF1145DB6C515FB34","name":"Foo Bar","parent_id":"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},"parent_id":{"$ref":"#/components/schemas/Id"}},"required":["code","id","name","parent_id"],"title":"V2NAICS2012","type":"object","x-struct":"Elixir.TalariaWeb.Schemas.V2.Catalog.Naics2012","x-validate":null}},"schema_20":{"kind":"json-schema","data":{"default":10,"minimum":1,"type":"integer","x-struct":null,"x-validate":null},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"default":0,"minimum":0,"type":"integer","x-struct":null,"x-validate":null},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"string","x-struct":null,"x-validate":null},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"default":20,"minimum":1,"type":"integer","x-struct":null,"x-validate":null},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"minLength":2,"type":"string","x-struct":null,"x-validate":null},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TaxonomyType"},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"default":50,"maximum":500,"minimum":1,"type":"integer","x-struct":null,"x-validate":null},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"default":0,"maximum":10000,"minimum":0,"type":"integer","x-struct":null,"x-validate":null},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"default":false,"type":"boolean","x-struct":null,"x-validate":null},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"properties":{"error":{"example":"upstream_error","type":"string","x-struct":null,"x-validate":null}},"type":"object","x-struct":null,"x-validate":null},"id":"schema_29"}},"exampleStore":{},"securitySchemeStore":{"authorization":{"id":"authorization","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}},"servers":[{"url":"https://api.hginsights.com"}]},"options":{"hideSchemaTitles":true,"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/v2/openapi.json?download"},{"url":"/_bundle/v2/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"HG Insights API"}},"baseSlug":"/v2/openapi","routesMapping":{}}