Fetch data

The SDK provides methods to retrieve data from the Engagement platform. Responses are available in a completion handler closure.

Fetch recommendations

Use the fetchRecommendation method to get personalized recommendations for the current customer from an Engagement recommendation model.

The method returns a RecommendationResponse object containing the system data (the recommendation engine data and recommended item IDs) and, if applicable, the user-defined data. To specify user-defined properties, you can use the generic type parameter T: RecommendationUserData. It's a simple struct with coding keys representing your custom properties. If you only need the system properties, you can use EmptyRecommendationData.

Arguments

RecommendationOptions

Example

struct MyRecommendation: RecommendationUserData {
    // put all the custom properties on your recommendations into a struct
    // and call fetchRecommendation with it in results callback
    let 
}

typealias MyRecommendationResponse = RecommendationResponse<MyRecommendation>

// Prepare the recommendation options
let recommendationOptions = RecommendationOptions(
    id: "65c2a2bc0827bbe25d2b67cc",
    fillWithRandom: true,
    size: 5,
    items: ["product456":"10", "product123":"1"]
)

// Get recommendations for the current customer
Exponea.shared.fetchRecommendation(with: recommendationOptions) { (result: Result<MyRecommendationResponse>) in
    if case .success(let recommendation) = result {
        // In case of success, value contains list of recommendations
        print(recommendation.value?[0].userData)
        print(recommendation.value?[0].systemData)
    }
}

Return object

RecommendationResponse

Recommendation

RecommendationSystemData

Fetch consent categories

Use the fetchConsents method to get a list of your consent categories and their definitions.

Use when you want to get a list of your existing consent categories and their properties, such as sources and translations. This is useful when rendering a consent form.

The method returns a ConsentsResponse object containing an array of Consent objects.

Example

// Fetch consents to get existing consent categories.
Exponea.shared.fetchConsents { (result) in
    switch result {
    case .success(let response):
        print(response.consents)
        
    case .failure(let error):
        print(error.localizedDescription)
    }
}

Result object

ConsentsResponse

Consent

ConsentSources