Getting Users from Engage API by data_group_id and cohort_id
In the Query Profiles of the Engage API, Tell me the code to get the list of users using both data_group_id and cohort_id.
In the Query Profiles of the Engage API, Tell me the code to get the list of users using both data_group_id and cohort_id.
Hi 石川 明., Please stand by as I search the Mixpanel knowledge base for an AI-powered answer. I normally take about 15 seconds or so. In case AI cannot answer your question, feel free to reach out to Mixpanel support at mixpanel.com/get-support. If you have follow-up questions for this thread, please tag me again with your question: @kapa.ai <follow-up question> 👋
Feel free to ask a follow-up question once I've answered by mentioning me with @kapa.ai
To get the list of users using both data_group_id and cohort_id in the Query Profiles of the Engage API, you can use the following code: LBKScurl --request POST \ --url [https://eu.mixpanel.com/api/2.0/engage](https://eu.mixpanel.com/api/2.0/engage) \ --header 'Authorization: Basic <redacted> ' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data 'filter_by_cohort={"id": <cohort_id_here> }' \ --data data_group_id=<data_group_id_here> LBKSThis code snippet combines both the filter_by_cohort parameter to specify a cohort and the data_group_id parameter to query group profiles. Here's a breakdown of what each part does: 1. The filter_by_cohort parameter is used to specify the cohort ID you want to filter by.
2. The data_group_id parameter is used to query group profiles instead of user profiles.You'll need to replace <cohort_id_here> with the actual ID of the cohort you want to filter by, and <data_group_id_here> with the ID of the group key you're interested in.Remember to replace <redacted> in the Authorization header with your actual API credentials.This approach allows you to get a list of users that belong to both a specific cohort and a specific group.Exporting Group Profiles via API
kapa.ai is still learning and improving, please let me know how I did by reacting below.
ℹ️ Tip: Mention @kapa.ai in the thread for follow-ups or DM the app for 1-to-1 help.
Let me check the knowledge base for you again. One moment! 📚
Yes, you can specify a cohort created using a group profile for the cohort_id after specifying the data_group_id. However, it's important to understand how this combination works and what results you'll obtain.When you use both data_group_id and filter_by_cohort (which includes the cohort_id), you're essentially applying two filters to your query: 1. The data_group_id specifies that you're querying group profiles instead of user profiles.
2. The filter_by_cohort further filters these group profiles based on the specified cohort.The result you obtain will be a list of group profiles (not individual user profiles) that meet both criteria: 1. They belong to the group specified by data_group_id.
2. They are part of the cohort specified by cohort_id.It's important to note that when you're querying group profiles, the cohort should be defined based on group properties or behaviors, not individual user properties or behaviors.According to the Mixpanel documentation: Group Analysis in Reports states:
"Group properties are supported when analyzing by users, but user properties are not supported when analyzing by groups."This means that while you can create cohorts based on group properties and use them in your query, you should ensure that the cohort you're using is indeed based on group-level criteria.The exact list of results will depend on how your group profiles and cohort are defined. If you need to get individual user profiles that are associated with these groups, you would need to perform additional queries or data processing after obtaining the group profile results.Remember that the Engage API has certain limitations and behaviors when dealing with group analytics, so it's crucial to design your queries with these considerations in mind.
kapa.ai is still learning and improving, please let me know how I did by reacting below.
ℹ️ Tip: Mention @kapa.ai in the thread for follow-ups or DM the app for 1-to-1 help.
Let me check the knowledge base for you again. One moment! 📚
Yes, there is a way to get the user profiles included in a group using the cohort ID. You can use the Engage API endpoint with the filter_by_cohort parameter to achieve this. Here's how you can do it: LBKScurl --request POST \ --url [https://mixpanel.com/api/2.0/engage](https://mixpanel.com/api/2.0/engage) \ --header 'Authorization: Basic <redacted> ' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data 'filter_by_cohort={"id": <cohort_id_here> }'LBKSIn this request: 1. Replace <redacted> with your actual API credentials.
2. Replace <cohort_id_here> with the ID of the cohort you want to query.This method will return user profiles that are part of the specified cohort. If the cohort was created based on group criteria, the returned profiles will be the users associated with those groups.It's important to note a few things: 1. This method returns user profiles, not group profiles. If you need group profiles, you would use the data_group_id parameter as discussed in our previous conversation.2. According to the Engage API documentation, "Query user (or group) profile data and return list of users (or groups) that fit specified parameters."3. The API has some limitations. As stated in the documentation: "API responses will return at most page_size records for each request. To request additional records, callers should repeat their call to the API using the same where param, but provide a session_id parameter with a value taken from the first response, and include a page parameter with a value one greater than the value of page in the response."4. Be aware of the rate limits: "The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries."If you need to get more specific data or combine this with group information, you might need to perform additional queries or data processing after obtaining these results.Engage API documentation
kapa.ai is still learning and improving, please let me know how I did by reacting below.
ℹ️ Tip: Mention @kapa.ai in the thread for follow-ups or DM the app for 1-to-1 help.