Get Semantic Model Metadata

Beta

GET

https://api.athenaintel.com/api/v0/semantic-model/:asset_id/meta

GET

/api/v0/semantic-model/:asset_id/meta

curl https://api.athenaintel.com/api/v0/semantic-model/asset_id/meta \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json"

{
  "cubes": [
    {
      "description": "Cube containing sales transactions and related metrics",
      "dimensions": [
        {
          "description": "Date of the order",
          "name": "order_date",
          "sql": "order_date",
          "type": "time"
        },
        {
          "description": "Region of the customer",
          "name": "customer_region",
          "sql": "region",
          "type": "string"
        }
      ],
      "joins": [
        {
          "description": "Join to customers table",
          "name": "customers",
          "sql": "sales_data.customer_id = customers.id",
          "type": "belongsTo"
        }
      ],
      "measures": [
        {
          "description": "Total revenue from sales",
          "name": "total_revenue",
          "sql": "amount * price",
          "type": "sum"
        },
        {
          "description": "Number of orders",
          "name": "order_count",
          "sql": "order_id",
          "type": "count"
        }
      ],
      "name": "sales_data",
      "segments": [
        {
          "description": "Orders with revenue greater than 1000",
          "name": "high_value_orders",
          "sql": "amount * price > 1000"
        }
      ],
      "type": "cube"
    }
  ],
  "views": [
    {
      "description": "Aggregated monthly sales data for reporting",
      "dimensions": [
        {
          "description": "Month of the sales",
          "name": "month",
          "sql": "DATE_TRUNC('month', order_date)",
          "type": "time"
        }
      ],
      "measures": [
        {
          "description": "Total revenue per month",
          "name": "monthly_revenue",
          "sql": "amount * price",
          "type": "sum"
        }
      ],
      "name": "monthly_sales_summary",
      "type": "view"
    }
  ]
}

Get metadata for a semantic model including all cubes, measures, dimensions, segments, and joins.

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

asset_idstringRequired

Response

Successful Response

cubeslist of maps from strings to any

All meta entries (cubes + views) in author order. Each entry has a ‘type’ field — ‘cube’ or ‘view’.

viewslist of maps from strings to anyOptional

View-only subset of ‘cubes’ for convenience. Empty when no views are defined.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

502

Bad Gateway Error

Authentication

Path parameters

Headers

Response

Errors