HEherondata
EndUserQueries

Execute saved queries

Changed on

Execute saved SQL queries by name for a specific end user and return results

post/api/end_user_queries/execute

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/end_user_queries/execute
  • Auth
    API key in header x-api-key

Request body

end_user_heron_idstring required

Heron ID of the end user

query_namesstring[] required

List of saved query names to execute

Example request

{
  "end_user_heron_id": "eu_abc123",
  "query_names": [
    "monthly_revenue",
    "top_transactions"
  ]
}

Response

Successfully executed queries

object required

Example response

{
  "results": {
    "monthly_revenue": {
      "column_order": [
        "month",
        "revenue"
      ],
      "records": [
        {
          "month": "2024-01",
          "revenue": 50000
        }
      ]
    },
    "top_transactions": {
      "column_order": [
        "id",
        "amount"
      ],
      "records": [
        {
          "amount": 1000,
          "id": 1
        }
      ]
    }
  }
}

Changes