Builder.io Analytics API

Deprecated

With the Analytics API you can query any analytics you have in Builder using SQL.

Tip: For more detailed information, read Programming Custom Dashboards.

Prerequisites

To use the Builder Analytics API, you must have a Private API Key. Remember to keep your Private API secret.

Using the API

To query your analytics in Builder, send a GET request as in the following example:

curl --location --request POST 'https://cdn.builder.io/api/v1/query-metrics?apiKey=API_KEY' \
--header 'Authorization: Bearer PRIVATE_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"query": "SELECT COUNT(*) FROM @events WHERE TYPE = \"CLICK\" "
}'

Example response

{
  "results": [{ COUNT: 123 }]
}

The Analytics API is only available with Builder Enterprise plans. For full details on usage of the API, please contact the Builder support team.