Endpoint
cohorts/search
Allows a user to obtain a Motionworks identifier for a specific cohort (this is also called a motionworks_segment_id).
Type
POST
Request Parameters
- Required
motionworks_data_product_name- Can be "Popcast at Home" or "Popcast Anytime"
- Optional
search_text- Provide a word or phrase to search the cohort descriptions to narrow down the response
Responses
-
200 OK: Successfully retrieved cohort -
404 Not Found: No cohorts can be found
The response is a JSON object with one top-level property:
- cohorts: an array of cohort objects.
Each cohort object has two string fields:
- motionworks_segment_id – a UUID identifying the segment
- cohort_description – a human-readable description of that segment
Example Request
curl --location 'https://intermx-test.apigee.net/v1/cohorts/search' \
--header 'apikey: {YOUR API KEY HERE}' \
--header 'Content-Type: application/json' \
--data '{
"motionworks_data_product_name": "Popcast At Home",
"search_text": "video displays"
}' Example Response
{
"cohorts": [
{
"motionworks_segment_id": "d03b0d5b-7732-4b5e-8cfe-3c59be0537d7",
"cohort_description": "Places viewed digital video displays past 6 mo Health clubs/fitness centers"
},
{
"motionworks_segment_id": "a6f6f6d3-362b-435d-9f8d-bcdc3718e5b2",
"cohort_description": "Places viewed digital video displays past 6 months Airplanes"
},
{
"motionworks_segment_id": "b2862ed4-68c9-4124-971b-1c8e03362451",
"cohort_description": "Places viewed digital video displays past 6 months Airports"
},
{
"motionworks_segment_id": "6fb69132-84d2-4194-81c4-908c1dd8200b",
"cohort_description": "Places viewed digital video displays past 6 months Doctors offices/hospitals"
},
{
"motionworks_segment_id": "6ac0d738-a75e-4b1f-aed0-ac59b367b558",
"cohort_description": "Places viewed digital video displays past 6 months Gas stations"
}
]
}