Skip to main content
Segment Recommendations
curl --request GET \
  --url https://api.example.com/v1/recommendations/segments/{segment_id} \
  --header 'segment_id: <segment_id>'

​
Authentication Required

This endpoint requires API key authentication via Bearer token in the Authorization header. 
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

​
Path Parameters

​
segment_id
string
required
Unique identifier for the customer segment to get recommendations for

​
Response

The API returns a JSON object with segment recommendations: 
{
  "recommendation_id": "00000000-1234-5678-9abc-def012345678",
  "name": "Early Twenties",
  "segment_id": "cmcapwfrl01zk3m2t0axbh05e",
  "offers": [
    "00000000-aaca-4844-9cb0-54af8f897322",
    "00000001-c020-4d37-8d6e-4e4e30ff5671",
    "00000002-5fe2-466c-b58a-5ac8db631334"
  ],
  "type": "SEGMENT"
}
FieldTypeDescription
recommendation_idstringUnique identifier for the recommendation
namestringHuman-readable name for the segment
segment_idstringIdentifier of the segment (matches the path parameter)
offersarrayArray of offer UUIDs that are recommended
typestringType of recommendation (SELF or SEGMENT)

​
Error Codes

Status CodeDescription
200Recommendations retrieved successfully
400Invalid segment_id format
401Unauthorized - Invalid or missing API key
404Segment not found
500Internal server error

​
Example

curl -X GET https://api.hellocobi.com/v1/recommendations/segments/cmcapwfrl00zk3m2t0axba05e \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Best Practices

  1. Caching: Cache segment recommendations as they change less frequently than individual customer recommendations
  2. Error Handling: Implement proper error handling for cases where no recommendations are available
  3. Rate Limiting: Be mindful of API rate limits (1000 requests per minute)
  4. Validation: Validate the segment_id format before making the request
Need help? Contact our support team at [email protected]