FreeWheel

​

Accessing FreeWheel Cohorts for Targeting

var cohorts;

try {
  cohorts = JSON.parse(window.localStorage._pfws || '[]').slice(0, 250).toString();
} catch (e) {
  cohorts = '';
}

// Use the cohorts variable to append to your FreeWheel ad request
// Example: append as key-value pairs in your ad request configuration

​

Implementation Notes

• Ensure the Permutive SDK loads before you attempt to retrieve cohort IDs from local storage.
• The cohort IDs are updated in real-time as users enter or exit cohorts.
• You can append up to 250 cohort IDs per ad request (the .slice(0, 250) in the example limits this).
• Coordinate with your development team to integrate this code into your FreeWheel ad request flow.

// Import Permutive SDK
import Permutive

// Access FreeWheel Cohort IDs directly
let freeWheelCohorts: [String] = activations['freewheel']

// Construct your FreeWheel ad request
// Append Permutive cohorts as key-values
if !freeWheelCohorts.isEmpty {
    let cohortsString = freeWheelCohorts.joined(separator: ",")
    // Append cohortsString to your FreeWheel ad request
}

• The activations property provides direct access to cohort IDs configured for FreeWheel activation
• Use the key freewheel to retrieve FreeWheel-specific cohorts
• Coordinate with your development team to integrate this code into your FreeWheel ad request flow

val triggerAction: TriggerAction = triggersProvider.cohortActivations(
    activationType = "freewheel",
    callback = object : Method<List<String>> {
        override fun invoke(cohorts: List<String>) {
            if (cohorts.isNotEmpty()) {
                // Cohorts available for FreeWheel activation
                // Pass these to your FreeWheel ad requests as key-values
                println("FreeWheel cohorts: $cohorts")
            } else {
                println("No active cohorts with a FreeWheel activation configured.")
            }
        }
    }
)

• The TriggersProvider API allows you to listen for cohort membership changes
• Use the activation type freewheel to retrieve FreeWheel-specific cohorts
• See the Android SDK documentation for more details

​

How it Works

1. Track events for a specific user (optional)
2. Retrieve cohort IDs for activation

curl --request POST \
     --url 'https://api.permutive.app/ccs/v1/segmentation?activations=true&synchronous-validation=false&k=PERMUTIVE_API_KEY' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "alias": {
    "tag": "example",
    "id": "12345"
  },
  "events": []
}
'

{
  "user_id": "2008c38f-dece-4570-976d-87593ed001c3",
  "cohorts": ["12345", "23456", "34567"],
  "activations": {
    "freewheel": ["12345", "23456"]
  }
}

• Replace PERMUTIVE_API_KEY with your actual Permutive API key
• The activations=true query parameter is required to receive activation data in the response

• Permutive collects IDFA values from iOS users via the Permutive SDK
• Cohort memberships are synced daily to FreeWheel server-to-server
• Cohorts appear as Audiences in FreeWheel, ready for campaign targeting
• Data syncing happens automatically once configured in the Permutive Dashboard

• Permutive SDK must be deployed on your iOS app
• IDFA collection must be enabled and properly configured
• Users must grant tracking permission for IDFA to be available

• Permutive collects AAID values from Android users via the Permutive SDK
• Cohort memberships are synced daily to FreeWheel server-to-server
• Cohorts appear as Audiences in FreeWheel, ready for campaign targeting
• Data syncing happens automatically once configured in the Permutive Dashboard

• Permutive SDK must be deployed on your Android app
• AAID collection must be enabled and properly configured

• Permutive collects IP addresses (or other supported identifiers) from CTV users
• Cohort memberships are synced daily to FreeWheel server-to-server
• Cohorts appear as Audiences in FreeWheel, ready for campaign targeting
• Data syncing happens automatically once configured in the Permutive Dashboard

• Permutive must be collecting IP addresses or other supported identifiers from your CTV environment
• Work with your Permutive Customer Success Manager to ensure proper identity collection for CTV