One-time Queries
Learn how to use our three one-time query endpoints to submit a new query, check the query run status, and fetch the completed query results.
One-time queries are good for pulling data over custom date ranges. One-time queries must be submitted anew for every unique run if your team wants to run the same report (using the same metrics, dimensions, and/or filters) over unique date ranges (using unique start and end date parameters).
Getting data back from a one-time query is a three-step process using each of the below one-time API endpoints:
  1. 1.
    Run a /submit/ call to submit your new query and receive a query ID.
  2. 2.
    Run a /status/ call to check the status of your submitted query using the query ID from your previous call to the /submit/ endpoint. Continue running as frequently as every ten seconds or so until you receive a completed status for your query.
  3. 3.
    Once the status of your query is completed, run a /fetch/ call with the original query ID to download your completed query results.
get
https://api.chartbeat.com
/query/v2/submit/
Submit One-time Query
get
https://api.chartbeat.com
/query/v2/status/
Get Status of One-time Query
get
https://api.chartbeat.com
/query/v2/fetch/
Fetch One-time Query
Last modified 9mo ago