Skip to main content


In your Rill project directory, create a new file name <api-name>.yaml in the apis directory containing a custom API definition. See comprehensive documentation on how to define and use custom APIs


type — Refers to the resource type and must be api (required).

Either one of the following:

  • sql — General SQL query referring a model (required).

  • metrics_sql — SQL query referring metrics definition and dimensions defined in the metrics view (required).