Insight Subtype
The insightSubtype
parameter allows you to request specific categories of insights when using the generate-insights
API. This parameter helps refine the insights returned, enabling targeted research and ensuring relevance to your needs.
Parameter Details
Parameter | Description | Type | Required |
---|---|---|---|
insightSubtype | Specifies the subtype of insight to retrieve (e.g., negativeGrowth , cybersecurityBreaches ). | String | No |
Key Features
- Customization: Retrieve only the insights most relevant to your use case.
- Efficiency: Filter out irrelevant insights to focus on actionable data.
- Versatility: Supports hundreds of subtypes across categories like Financial, Cybersecurity, HR, and more.
Example Usage
Request Insights for a Specific Subtype
{
"contactEmail": "[email protected]",
"insightSubtype": "negativeGrowth"
}
Response
{
"insights": [
{
"name": "Negative quarterly revenue growth",
"description": "The company reported a -5.5% YOY decline in quarterly revenue.",
"type": "Financial",
"subType": "negativeGrowth"
}
]
}
Full List of Subtypes
For a complete list of supported subtypes, refer to the List of Insight Subtypes.
Updated 2 months ago