Insight Subtype
The insightSubtype
parameter allows users to specify which types of insights they want returned from the generate-insights
API. This improves relevance, reduces noise, and enables more targeted insight generation for personalized content or research workflows.
Parameter Definition
Parameter | Description | Type | Required |
---|---|---|---|
insightSubtype | One or more insight subtypes to retrieve (e.g., negativeGrowth , cybersecurityBreaches , etc.) | string or string[] | No |
You can pass either a single subtype or an array of up to 10 subtypes per request.
Key Features
- Targeted Retrieval: Pull insights relevant to specific categories like Financial, Cybersecurity, HR, Social Media, and more.
- Multi-subtype Support: Pass an array of insight subtypes to retrieve multiple types in a single request.
- Custom Insight Input: Supports subtype-specific input variables for added precision.
- Efficient Responses: Filtered insights grouped by subtype, reducing the need for post-processing.
Example Requests
Single Subtype
{
"contactEmail": "prospect@company.com",
"insightSubtype": "negativeGrowth"
}
Multiple Subtypes with Input Variables
{
"contactEmail": "prospect@company.com",
"insightSubtype": ["earningsCall", "personality", "schoolMascot"],
"inputVariables": {
"earningTranscriptQuarter": "Q3",
"earningTranscriptYear": "2024",
"personalityProfessionalLevel": "6 months",
"schoolCity": "Austin"
}
}
Example Response
{
"insights": {
"negativeGrowth": [
{
"title": "Negative quarterly revenue growth",
"description": "The company reported a -5.5% YOY decline in quarterly revenue.",
"type": "Financial",
"subType": "negativeGrowth"
}
],
"socialMedia": [
{
"title": "Appeared in podcast",
"description": "The CEO discussed AI strategies on a podcast.",
"type": "socialMedia",
"subType": "podcast"
}
]
},
"errors": {
"message": "No data available for the following insight subtypes: [earningsCall]. Consider trying a different subtype or prospect."
}
}
Limits
Limit Type | Value |
---|---|
Max subtypes per request | 10 subtypes |
Max insights per subtype | 2 insights |
Total insights per request | 20 insights max |
Note: This override applies only when a subtype array is specified. Default behavior (without
insightSubtype
) still allows up to 20 insights total across all types.
Error Handling
- Invalid Subtypes: If any subtype is invalid, the entire request fails with a clear message listing the invalid entries.
{
"error": "The provided insight subtype(s) [\"earnninngz\", \"badValue\"] are not valid. Refer to the docs: https://autobound-api.readme.io/docs/list-of-insight-subtypes"
}
- No Available Insights: If one or more valid subtypes have no available data, they’re returned as empty with an explanation under
errors
.
Reference
For the full list of supported subtypes, visit:
👉 Insight Subtype Reference
Updated 4 days ago