Search profiles with the Mixpanel API

Returns the user profiles that match a where expression, a cohort or a list of distinct_ids, with their properties. A page holds up to page_size profiles: for the next one, repeat the call with the same filters, the session_id of the response and page plus one. Counts toward the Query API limit of 60 queries per hour.

Identifier
mixpanel_search_profiles

The request

POST https://connect.reportei.com/api/tools/mixpanel_search_profiles/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "project_id": 1
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
project_idintegerYesId of the project, sent as a number: a key of results.projects in List projects, or the number after /project/ in the URL of Mixpanel.
workspace_idintegerNoOnly for projects that use data views: the id of the global data view, a key of results.workspaces in List projects, sent as a number.
wherestringNoExpression that filters the profiles, for example properties["$email"] == "ana@example.com".
distinct_idstringNoThe $distinct_id of one profile, as Search profiles returns it, usually the user id of your own product.
distinct_idsstringNoJSON array of $distinct_id values, as text, for example ["id1","id2"]. They come from Search profiles or are the user ids of your own product.
filter_by_cohortstringNoJSON object with the id of a cohort from List cohorts, as text, for example {"id":12345}.
include_all_usersbooleanNoOnly with filter_by_cohort. true, the default, also returns cohort members without a profile; false returns only members with a profile.
output_propertiesstringNoJSON array of the property names to return, as text, for example ["$email","$name"]. Omit it to return every property.
session_idstringNoThe session_id of the previous response of Search profiles, to read the next page.
pageintegerNoPage to read, starting at 0. Above 0 it needs session_id.

Supported connections

Your customer connects their Mixpanel account once, with one of the modes below. The same connection serves every tool of the toolkit.

Username and password

Your customer enters the app credentials on a Connect screen, or your system sends them with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/mixpanel_search_profiles. It becomes your agent's tool definition with no conversion.

Other Mixpanel tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.