Skip to main content


Scuba Docs

Programmatically query Scuba

Scuba provides an external query API that you can use to programmatically send queries to Scuba and receive query results.

For some customers, Scuba is one of several analytics processes they run, and consolidating these various analyses in a single report or dashboard is important. Other customers need aggregated data from Scuba to feed into separate processes. For example, you might want to use data from Scuba queries as input to Power BI. With the external API, you can run queries outside of the Scuba user interface.

For information about formatting your API call, see Use the Scuba external query API.

Choose from the following methods of creating a query:

  • Create the query in the Scuba UI. Use the query number from the query's URL to rerun the query using the API. See Use the Scuba external query API.
  • Create the query at the command line using the Scuba behavioral analytics query language, BAQL. To learn about the rich and flexible language available for querying Scuba, see Create queries using the Scuba query language and the articles contained therein.
  • Was this article helpful?