Mixpanel

Parámetros de entrada

• namestringObligatorio

  The name of the property you would like to get data for

• typestringObligatorio

  The analysis type you would like to get data for

• unitstringObligatorio

  The level of granularity of the data

• eventstringObligatorio

  The event that you wish to get data for. Note: this is a single event name, not an array

• limitinteger

  The maximum number of values to return

• formatstring

  The data return format

• valuesstring[]

  The specific property values that you would like to get data for. Example: ['female', 'unknown']

• to_datestring

  The date in yyyy-mm-dd format to query to (inclusive)

• intervalinteger

  The number of units to return data for. Specify either interval or from_date and to_date

• from_datestring

  The date in yyyy-mm-dd format to begin querying from (inclusive)

• project_idintegerObligatorio

  Required if using service account to authenticate request

• workspace_idinteger

  The id of the workspace if applicable

Parámetros de salida

• dataobjectObligatorio

  The response data containing series and values

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

• legend_sizeintegerObligatorio

  Size of the legend

Parámetros de entrada

• typestring

  Type of aggregation

• unitstring

  Time unit for grouping results

• eventstring

  Name of the event to analyze

• wherestring

  Expression to filter events

• eventsstring[]

  List of event names to analyze

• to_datestringObligatoriodate

  End date for the query (inclusive)

• intervalinteger

  Time interval for the results in seconds

• from_datestringObligatoriodate

  Start date for the query (inclusive)

• project_idintegerObligatorio

  The ID of the project to query

• workspace_idinteger

  The ID of the workspace if applicable

Parámetros de salida

• dataobjectObligatorio

  Raw event count data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• typestring

  Type of aggregation

• unitstring

  Time unit for grouping results

• eventstring

  Name of the event to analyze

• limitinteger

  Maximum number of results to return

• wherestring

  Expression to filter events

• eventsstring[]

  List of event names to analyze

• to_datestringObligatoriodate

  End date for the query (inclusive)

• intervalinteger

  Time interval for the results in seconds

• from_datestringObligatoriodate

  Start date for the query (inclusive)

• project_idintegerObligatorio

  The ID of the project to query

• workspace_idinteger

  The ID of the workspace if applicable

Parámetros de salida

• dataobjectObligatorio

  Raw event breakdown data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• paramsobject

  A JSON-encoded object that will be made available in the script as `params`. Use this to pass dynamic date ranges, event names, or other parameters into your JQL query.

• scriptstringObligatorio

  A **fully valid** JavaScript code snippet that defines **`function main() { ... }`** and returns the final dataset. The script is compiled and executed by Mixpanel's JQL engine. -------------------------------------------------------------------------------------------- ### **COMPLETE JQL REFERENCE** JQL (JavaScript Query Language) allows you to query Mixpanel's raw event or user (profile) data using standard JavaScript transformations. Below is a comprehensive reference to help you generate queries, including how to: - **Fetch event data** with `Events()`. - **Fetch user profiles** with `People()`. - **Join** events and profiles with `join()`. - Apply **filters**, **mappers**, and **reducers** (aggregations) with `.filter()`, `.map()`, `.reduce()`, etc. - Group results with `.groupBy()` or `.groupByUser()`. - Use built-in reducers like `count()`, `sum()`, `avg()`, etc. - Pass dynamic parameters via the `params` object. Your script must have **exactly** one top-level function named `main()`. For example: ```js function main() { // 1) Fetch a data source (Events, People, or join(...)). // 2) Transform/aggregate as needed. // 3) Return the final results. } ``` -------------------------------------------------------------------------------------------- ## **DATA SOURCES** 1. **Events(params)** - Fetch raw event data. Each event object typically has: - `name`: The event name (string). - `distinct_id`: The user's distinct ID. - `time`: Timestamp in milliseconds since epoch (project timezone, not UTC). - `properties`: An object with all event properties. - **Common arguments** to `Events()`: ```js Events({ from_date: "YYYY-MM-DD", to_date: "YYYY-MM-DD", event_selectors: [ { event: "EventName", selector: "properties[\"country\"] == \"US\"", label: "Custom Label" // optional label } ] // user_selectors can also be used in People() if needed. }) ``` - The `selector` field supports **Segmentation Expressions**, e.g.: `"properties[\"app_name\"] == \"gmail\" and properties[\"some_flag\"] == true"`. 2. **People(params)** - Fetch user profiles. Each user object has: - `distinct_id`: The user's unique ID. - `time`: Timestamp of the most recent update. - `last_seen`: Timestamp of the most recent profile Set() call. - `properties`: An object of user properties (e.g. `signup_date`, `email`, `country`, etc.). - **Example**: ```js People({ user_selectors: [ { selector: "user[\"$email\"] == \"someone@example.com\"" } ] }) // or People() .filter(u => u.properties.age > 30); ``` 3. **join(Events(...), People(...), { type, selectors })** - Combine events with user profiles on the same `distinct_id`. - Each joined item has `{ distinct_id, event, user }`, where `event` is an event object and `user` is a user object. - **type** can be `full`, `left`, `right`, or `inner` (defaults to `full`). - You can use selectors referencing **both** event & user properties. ```js join( Events({ from_date: '2023-01-01', to_date: '2023-01-31' }), People(), { type: 'inner', selectors: [ { selector: 'properties[\"country\"] == "US" and user[\"age\"] > 30' } ] } ) ``` -------------------------------------------------------------------------------------------- ## **TRANSFORMATIONS** (Methods that process collections) After fetching a data source, you can chain transformations. The final result of your chain is what you `return` in `main()`. 1. **filter(fn)**: - Keep only items for which `fn(item)` is `true`. - Example: ```js .filter(e => e.name === "Sign Up" && e.properties.country === "US") ``` 2. **map(fn)**: - Transform each item in the collection. - Example: ```js .map(e => { return { originalEventName: e.name, city: e.properties.$city }; }) ``` 3. **reduce(reducerFn)**: - Aggregates the entire collection into **one** value. - Built-in reducers exist (see below), or you can write a custom function with signature `(accumulators, items) => { ... }`. 4. **groupBy(keys, reducer)**: - Group items by the specified keys, then apply a reducer to each group. - Returns an array of objects in the form: ```js [ { key: [...], value: <reduced result> }, ... ] ``` - **Keys** can be property paths like `'properties.$city'` or a function `(item) => item.name`. - Example: ```js .groupBy([ "properties.country", "properties.browser" ], mixpanel.reducer.count()) ``` 5. **groupByUser([optionalKeys], reducer)**: - Similar to `groupBy`, but automatically groups all events for each user (`distinct_id`) **in chronological order**. - Allows analysis of user event sequences, e.g., finding the next event after a `login`. - The reducer function's signature is `(state, events) => { ... }` where `state` is the previously returned value. - Example: ```js .groupByUser([], function(state, events){ // examine event sequence... // return an updated state. }); ``` 6. **sortAsc(accessor)** / **sortDesc(accessor)**: - Sort the collection by an accessor property or function. - Example: ```js .sortDesc("value") ``` 7. **flatten()**: - Flattens arrays inside the collection into individual items. -------------------------------------------------------------------------------------------- ## **BUILT-IN REDUCERS** Reducers turn multiple items into a single value (for `.reduce()` or per-group in `.groupBy()`). Some commonly used: 1. **mixpanel.reducer.count()** - Count the number of items. 2. **mixpanel.reducer.sum(accessor)** / **mixpanel.reducer.avg(accessor)** - Sum or average numeric values. `accessor` can be a property string (e.g. 'properties.price') or a function. 3. **mixpanel.reducer.min(accessor)** / **mixpanel.reducer.max(accessor)** - The min or max numeric value in a collection. 4. **mixpanel.reducer.min_by(accessor)** / **max_by(accessor)** - Returns the item with the smallest/largest numeric accessor value. 5. **mixpanel.reducer.numeric_percentiles(accessor, [p1, p2, ...])** - Approximate percentile values (e.g., 50th, 90th, etc.) 6. **mixpanel.reducer.top(N)** - Returns the top N items by numeric `value`. 7. **mixpanel.reducer.any()** / **mixpanel.reducer.null()** / **mixpanel.reducer.object_merge()** - `any()`: Returns any one item. - `null()`: Always returns null. - `object_merge()`: Merge multiple objects by summing numeric fields. -------------------------------------------------------------------------------------------- ## **SEGMENTATION EXPRESSIONS** When using `event_selectors` or `user_selectors`, or the optional `selectors` in `join()`, you can supply **Segmentation Expressions** to filter by properties. Common operators: - `==`, `!=`, `>`, `>=`, `<`, `<=`, `in`, `and`, `or`, `not` - Typecasts: `string(...)`, `number(...)`, `boolean(...)` - Example: `properties["app_name"] == "gmail" and user["age"] > 30` -------------------------------------------------------------------------------------------- ## **PARAMS** You can pass a `params` object to the script. It's accessible inside `main()` via the global `params` variable. For example: ```js function main() { return Events({ from_date: params.start_date, to_date: params.end_date, event_selectors: [{ event: params.eventName }] }); } ``` This makes your query reusable for different date ranges or event names. -------------------------------------------------------------------------------------------- ## **EXAMPLES** 1. **All events named 'SERVER_EXECUTE_ACTION_END' from last 7 days, filtering on `app_name=gmail`:** ```js function main() { var now = new Date().getTime(); var sevenDaysAgo = now - (7 * 24 * 60 * 60 * 1000); return Events() .filter(e => e.name === 'SERVER_EXECUTE_ACTION_END' && e.properties.app_name === 'gmail' && e.time >= sevenDaysAgo); } ``` 2. **Getting user profiles who signed up in 2024** ```js function main() { return People() .filter(u => { var signup = new Date(u.properties.signup_date); return signup.getFullYear() === 2024; }); } ``` 3. **Join users and events (inner join) for a date range, filter by US users over age 30, then group by event name** ```js function main() { return join( Events({ from_date: '2024-01-01', to_date: '2024-01-31' }), People(), { type: 'inner', selectors: [ { selector: 'properties[\"country\"] == "US" and user[\"age\"] > 30' } ] } ) .filter(tuple => tuple.event) .groupBy([ev => ev.event.name], mixpanel.reducer.count()); } ``` 4. **Counting events by user using `groupByUser`** ```js function main() { return Events({ from_date: params.start_date, to_date: params.end_date }) .groupByUser(function(state, events) { // 'state' is the accumulator for this user; 'events' is the next chunk (in time order) state = state || 0; // init state if undefined return state + events.length; // increment by number of events in this chunk }); } ``` 5. **Combining transformations** ```js function main() { return Events({ from_date: '2025-01-01', to_date: '2025-01-31', event_selectors: [{ event: 'purchase' }] }) .filter(e => e.properties.country === 'CA') .map(e => e.properties.amount) .reduce(mixpanel.reducer.sum()); } ``` -------------------------------------------------------------------------------------------- ### **IMPORTANT**: The final result returned by `main()` must be your final data. You can return: - An array or list of objects. - A single number (if you used `.reduce()` to a numeric total). - A nested array if you used `.groupBy(...)`. -------------------------------------------------------------------------------------------- **Include `function main() { ... }` in its entirety** in this field. This ensures the Mixpanel JQL engine runs your code.

• project_idintegerObligatorio

  Required if using service account credentials or an API secret for authentication.

• workspace_idinteger

  The ID of the Mixpanel workspace, if applicable.

Parámetros de salida

• dataanyObligatorio

  The raw data (JSON) returned by Mixpanel after running your JQL script.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• project_idintegerObligatorio

  The ID of the project to query. Required if using service account authentication.

• workspace_idinteger

  The ID of the workspace if applicable

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• project_idintegerObligatorio

  Required if using service account to authenticate request

• workspace_idinteger

  The id of the workspace if applicable

Parámetros de salida

• dataobject[]Obligatorio

  Array of funnel information

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• to_datestringObligatoriodate

  End date for the query (inclusive, format: YYYY-MM-DD)

• from_datestringObligatoriodate

  Start date for the query (inclusive, format: YYYY-MM-DD)

• project_idintegerObligatorio

  The ID of the project to query. Required if using service account authentication.

• distinct_idsstring[]Obligatorio

  List of distinct_ids to return activity feeds for

• workspace_idinteger

  The ID of the workspace if applicable

Parámetros de salida

• dataobjectObligatorio

  Raw query results data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• onstring

  The property expression to segment the second event on

• unitstringObligatorio

  The overall time period to return frequency of actions for

• eventstring

  The event to generate returning counts for

• limitinteger

  Return the top limit segmentation values

• wherestring

  An expression to filter the returning events by

• to_datestringObligatorio

  The date in yyyy-mm-dd format to query to (inclusive)

• from_datestringObligatorio

  The date in yyyy-mm-dd format to begin querying from (inclusive)

• project_idintegerObligatorio

  Required if using service account to authenticate request

• workspace_idinteger

  The id of the workspace if applicable

• addiction_unitstringObligatorio

  The granularity to return frequency of actions at

Parámetros de salida

• dataobjectObligatorio

  The frequency data

• errorstring

  Error if any occurred during the execution of the action

• metadataobjectObligatorio

  Metadata about the query

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

• computed_atstringObligatorio

  Timestamp when the data was computed

Parámetros de entrada

• onstring

  The property expression to segment the event on

• unitstring

  Alternate way of specifying interval

• limitinteger

  Return the top property values. Maximum value 10,000

• wherestring

  An expression to filter events by

• lengthinteger

  The number of units each user has to complete the funnel. May not be greater than 90 days

• to_datestringObligatorio

  The date in yyyy-mm-dd format to query to (inclusive)

• intervalinteger

  The number of days you want each bucket to contain

• from_datestringObligatorio

  The date in yyyy-mm-dd format to begin querying from (inclusive)

• funnel_idintegerObligatorio

  The funnel that you wish to get data for

• project_idintegerObligatorio

  Required if using service account to authenticate request

• length_unitstring

  The unit applied to the length parameter

• workspace_idinteger

  The id of the workspace if applicable

Parámetros de salida

• dataobjectObligatorio

  Raw funnel query data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• project_idintegerObligatorio

  Required if using service account to authenticate request

• bookmark_idintegerObligatorio

  The ID of your Insights report

• workspace_idinteger

  The id of the workspace if applicable

Parámetros de salida

• dataobjectObligatorio

  Raw insight query data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• onstringObligatorio

  The numeric expression to average per unit time (should evaluate to a number)

• unitstring

  The time unit for bucketing values

• eventstringObligatorio

  The event to get data for (single event name)

• wherestring

  An expression to filter events by

• to_datestringObligatorio

  The date in yyyy-mm-dd format to query to (inclusive)

• from_datestringObligatorio

  The date in yyyy-mm-dd format to begin querying from (inclusive)

• project_idintegerObligatorio

  Required if using service account to authenticate request

• workspace_idinteger

  The id of the workspace if applicable

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• onstringObligatorio

  The numeric property expression to segment the event on

• typestring

  The time unit for bucketing values

• unitstring

  The time unit for bucketing property values

• eventstringObligatorio

  The event to get data for (single event name)

• wherestring

  An expression to filter events by

• to_datestringObligatorio

  The date in yyyy-mm-dd format to query to (inclusive)

• from_datestringObligatorio

  The date in yyyy-mm-dd format to begin querying from (inclusive)

• project_idintegerObligatorio

  Required if using service account to authenticate request

• workspace_idinteger

  The id of the workspace if applicable

Parámetros de salida

• dataobjectObligatorio

  Raw numeric segmentation query data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• onstringObligatorio

  The numeric expression to sum per unit time (should evaluate to a number)

• unitstring

  The time unit for bucketing values

• eventstringObligatorio

  The event to get data for (single event name)

• wherestring

  An expression to filter events by

• to_datestringObligatorio

  The date in yyyy-mm-dd format to query to (inclusive)

• from_datestringObligatorio

  The date in yyyy-mm-dd format to begin querying from (inclusive)

• project_idintegerObligatorio

  Required if using service account to authenticate request

• workspace_idinteger

  The id of the workspace if applicable

Parámetros de salida

• dataobjectObligatorio

  Raw numeric sum query data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Which page of results to retrieve (starts at 0)

• wherestring

  An expression to filter users (or groups) by

• behaviorsinteger

  Required when using event selector for user profiles

• project_idintegerObligatorio

  The ID of the project to query. Required if using service account authentication.

• session_idstring

  Session ID from a previous query for pagination

• distinct_idstring

  A unique identifier used to distinguish an individual profile

• distinct_idsstring[]

  A list of distinct_ids to retrieve profiles for

• workspace_idinteger

  The ID of the workspace if applicable

• data_group_idstring

  The ID of the group key, used when querying group profiles

• as_of_timestampinteger

  Used with behaviors parameter for large exports

• filter_by_cohortobject

  Filter by cohort ID. Example: {'id': 12345}

• include_all_usersboolean

  When using filter_by_cohort, whether to include all distinct_ids even without profiles

• output_propertiesstring[]

  List of property names to return in the response

Parámetros de salida

• dataobjectObligatorio

  Raw query results data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• onstring

  The property expression to segment the second event on

• unitstring

  The interval unit

• eventstring

  The event to generate returning counts for

• limitinteger

  Return the top limit segmentation values

• wherestring

  An expression to filter events by

• to_datestringObligatorio

  The date in yyyy-mm-dd format to query to (inclusive)

• intervalinteger

  The number of units per individual bucketed interval

• from_datestringObligatorio

  The date in yyyy-mm-dd format to begin querying from (inclusive)

• born_eventstring

  The first event a user must do to be counted in a birth retention cohort

• born_wherestring

  An expression to filter born_events by

• project_idintegerObligatorio

  Required if using service account to authenticate request

• workspace_idinteger

  The id of the workspace if applicable

• interval_countinteger

  The number of individual buckets that are returned

• retention_typestring

  Type of retention analysis

• unbounded_retentionboolean

  Whether retention values accumulate from right to left

Parámetros de salida

• dataobjectObligatorio

  Raw retention query data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• onstring

  The property expression to segment the event on

• typestring

  Type of count to return

• unitstring

  The time unit for bucketing property values

• eventstringObligatorio

  The event to get data for (single event name)

• limitinteger

  Return the top N property values (max 10000)

• wherestring

  An expression to filter events by

• to_datestringObligatorio

  The date in yyyy-mm-dd format to query to (inclusive)

• intervalinteger

  Number of days to bucket results into (used with type != 'general')

• from_datestringObligatorio

  The date in yyyy-mm-dd format to begin querying from (inclusive)

• project_idintegerObligatorio

  Required if using service account to authenticate request

• workspace_idinteger

  The id of the workspace if applicable

Parámetros de salida

• dataobjectObligatorio

  Raw segmentation query data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• typestringObligatorio

  The analysis type you would like to get data for - such as general, unique, or average events

• limitinteger

  The maximum number of events to return

• project_idintegerObligatorio

  Required if using service account to authenticate request

• workspace_idinteger

  The id of the workspace if applicable

Parámetros de salida

• dataobjectObligatorio

  Raw top events data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• eventstringObligatorio

  The event that you wish to get data for. Note: this is a single event name, not an array

• limitinteger

  The maximum number of properties to return

• project_idintegerObligatorio

  Required if using service account to authenticate request

• workspace_idinteger

  The id of the workspace if applicable

Parámetros de salida

• dataobjectObligatorio

  Raw top event properties data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of the property you would like to get data for

• eventstringObligatorio

  The event that you wish to get data for. Note: this is a single event name, not an array

• limitinteger

  The maximum number of values to return

• project_idintegerObligatorio

  Required if using service account to authenticate request

• workspace_idinteger

  The id of the workspace if applicable

Parámetros de salida

• dataarrayObligatorio

  Raw top event property values data as a list

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• typestringObligatorio

  The analysis type you would like to get data for - such as general, unique, or average events

• limitinteger

  The maximum number of values to return

• project_idintegerObligatorio

  Required if using service account to authenticate request

• workspace_idinteger

  The id of the workspace if applicable

Parámetros de salida

• dataarrayObligatorio

  Raw top events data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not