Sign in
Transformations

Get transformation model by ID

Changed on
get/models/transformations/{id}

Request

  • Base URL: http://localhost:8080/api/v1
  • URL: http://localhost:8080/api/v1/models/transformations/{id}
  • Auth: none declared

Path parameters

idstring required

Fully qualified model ID (database.table)

Response

Transformation model details

idstring required

Fully qualified ID (database.table)

databasestring required
tablestring required
descriptionstring
type'scheduled' | 'incremental' required

Transformation type (scheduled or incremental)

content_type'sql' | 'exec' required

Execution method (SQL query or shell command)

contentstring required

SQL query or exec command defining the transformation

has_overrideboolean

Whether this model has a config override record

is_disabledboolean

Whether this model is disabled by override

tagsstring[]

Tags for categorization

schedulestring

Cron expression (present when type=scheduled)

Example response

{
  "id": "analytics.daily_active_users",
  "database": "analytics",
  "table": "daily_active_users",
  "description": "Daily aggregation of unique active users",
  "content_type": "sql",
  "content": "SELECT\n  toDate(event_time) AS date,\n  uniqExact(user_id) AS active_users\nFROM sources.events\nWHERE event_time >= {{ start_time }}\n  AND event_time < {{ end_time }}\nGROUP BY date\n",
  "tags": [
    "analytics",
    "daily"
  ],
  "depends_on": [
    "ethereum.beacon_blocks",
    [
      "source1.data",
      "source2.data"
    ],
    "analytics.hourly_stats"
  ],
  "schedule": "@every 5m"
}

Changes

  • 8c61fff4cbc2Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • 23348f86801eRevision changes
    • info

      added the optional property / to the response with the status