This API requires a valid API key and returns all audience segments defined for the specified brand. If no segments exist, an error will be returned.
Request Endpoint: https://app.zyntrohq.com/apis/public/fetchAudiences.php
Request Method: POST
Request Payload:
{
"api_key": "your_zyntro_api_key",
"org_id": "your_zyntro_org_id",
"brand_id": "your_brand_id"
}Response (JSON):
{
"status": "success",
"message": "3 audience segments have been defined for your brand. You can ask your member in-charge to add more audiences if you like.",
"data": [
{
"segment_id": "audience_segment_unique_id",
"created_at": "2025-01-15 10:30:00",
"updated_at": "2025-01-15 14:45:00",
"initiated_by": "member_id_who_created_segment",
"segment_label": "Primary Target Audience",
"segment_tag": "high_value_prospects",
"segment_type": "demographic",
"segment_decision_drivers": "Quality, Price, Customer Service",
"segment_pain_points": ["time_constraints", "budget_limitations", "complex_solutions"],
"segment_use_cases": ["lead_generation", "customer_retention", "upselling"],
"segment_tone": "professional_friendly",
"reasoning": "This segment represents our ideal customers based on market research and past conversion data."
}
]
}Response Fields:
- status: Indicates success or error status
- message: Descriptive message about the response
- data: Array of audience segment objects
- segment_id: Unique identifier for the audience segment
- created_at: Timestamp when the segment was created
- updated_at: Timestamp when the segment was last updated
- initiated_by: ID of the member who created this segment
- segment_label: Human-readable label for the segment
- segment_tag: Short tag or category for the segment
- segment_type: Type of audience segment (demographic, behavioral, etc.)
- segment_decision_drivers: Key factors that drive decisions for this audience
- segment_pain_points: Array of pain points this audience experiences
- segment_use_cases: Array of use cases relevant to this audience
- segment_tone: Recommended communication tone for this audience
- reasoning: Explanation of why this segment was created
Notes:
- This is a public API and requires an API Key. You can get your API Key from inside your Zyntro Account under Me > API Keys
- Ensure that the api_key, org_id, and brand_id are valid and correspond to your Zyntro account credentials
- The brand_id should correspond to an existing brand within your organization
- If no audience segments exist for the brand, an error will be returned