The HTTP API is the lowest-level way to use JQL. At its core, the API is very simple: you write a script, and you post it to an API endpoint with some authentication parameters.
For longer scripts, you will likely want to keep the code in a file. If you had your script in a file called my_query.js, you could run it using the following cURL command:
-u YOUR_API_SECRET: \
--data-urlencode script@my_query.js
Note
- The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
- Queries will timeout after 2 minutes of run-time.
- You cannot make remote network requests (using XMLHttpRequest) from JavaScript.
- Queries to the JQL endpoint contribute to Query API rate limit and have their own individual limit as well. There is a maximum of 5 concurrent queries and of 60 queries per hour. There is also a 5 GB limit on data that can be processed in a single query, and a 2 GB limit on the resulting output data.
The HTTP API is the lowest-level way to use JQL. At its core, the API is very simple: you write a script, and you post it to an API endpoint with some authentication parameters.
For longer scripts, you will likely want to keep the code in a file. If you had your script in a file called my_query.js, you could run it using the following cURL command:
curl https://mixpanel.com/api/query/jql \
-u YOUR_API_SECRET: \
--data-urlencode script@my_query.js
Example curl with the script directly inside of the curl:
curl --request POST \
--url https://mixpanel.com/api/query/jql \
--header 'accept: application/json' \
--header 'content-type: application/x-www-form-urlencoded' \
--data 'script=function main(){
return Events(params)
.groupBy(
["name"],
mixpanel.reducer.count()
)
}
' \
--data 'params={
"scriptParam": "paramValue"
}
'
Note
- Queries will timeout after 2 minutes of run-time.
- You cannot make remote network requests (using XMLHttpRequest) from JavaScript.