ClickStack: Create Source

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

ClickStack: Creates a new source. The request body is a source object without the id field. If an id is sent anyway it is silently ignored (stripped before validation — the request is never rejected because of it). Granularity fields (materializedViews[].minGranularity and metadataMaterializedViews.granularity) accept the same short format the API returns (e.g. 5m, 15s, 1h, 1d).

POST

organizations

{organizationId}

services

{serviceId}

clickstack

sources

ClickStack: Create Source

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "name": "Logs",
  "kind": "log",
  "connection": "507f1f77bcf86cd799439012",
  "from": {
    "databaseName": "otel",
    "tableName": "otel_logs"
  },
  "defaultTableSelectExpression": "Timestamp, ServiceName, SeverityText, Body",
  "timestampValueExpression": "Timestamp",
  "id": "507f1f77bcf86cd799439011",
  "section": "Billing",
  "disabled": false,
  "querySettings": [
    {
      "setting": "max_threads",
      "value": "4"
    }
  ],
  "filterSettings": {
    "databaseName": "default",
    "tableName": "otel_logs",
    "columns": [
      {
        "name": "ServiceName",
        "label": "Service Name",
        "valueExpression": "lower(service_name)",
        "allowAll": false
      }
    ]
  },
  "serviceNameExpression": "ServiceName",
  "serviceVersionExpression": "ResourceAttributes['service.version']",
  "severityTextExpression": "SeverityText",
  "severityNumberExpression": "SeverityNumber",
  "bodyExpression": "Body",
  "eventNameExpression": "EventName",
  "eventAttributesExpression": "LogAttributes",
  "resourceAttributesExpression": "ResourceAttributes",
  "displayedTimestampValueExpression": "TimestampTime",
  "orderByExpression": "Timestamp DESC",
  "metricSourceId": "507f1f77bcf86cd799439013",
  "traceSourceId": "507f1f77bcf86cd799439014",
  "traceIdExpression": "TraceId",
  "spanIdExpression": "SpanId",
  "implicitColumnExpression": "Body",
  "knownColumnsListExpression": "Timestamp, Body, ServiceName",
  "useTextIndexForImplicitColumn": "auto",
  "highlightedTraceAttributeExpressions": [
    {
      "sqlExpression": "SpanAttributes['http.status_code']",
      "luceneExpression": "http.status_code",
      "alias": "HTTP Status Code"
    }
  ],
  "highlightedRowAttributeExpressions": [
    {
      "sqlExpression": "SpanAttributes['http.status_code']",
      "luceneExpression": "http.status_code",
      "alias": "HTTP Status Code"
    }
  ],
  "materializedViews": [
    {
      "databaseName": "otel",
      "tableName": "otel_logs_mv_5m",
      "dimensionColumns": "ServiceName, SeverityText",
      "minGranularity": "5m",
      "timestampColumn": "Timestamp",
      "aggregatedColumns": [
        {
          "aggFn": "sum",
          "mvColumn": "sum__Duration",
          "sourceColumn": "Duration"
        }
      ],
      "minDate": "2025-01-01T00:00:00Z"
    }
  ],
  "metadataMaterializedViews": {
    "keyRollupTable": "otel_logs_key_rollup_15m",
    "kvRollupTable": "otel_logs_kv_rollup_15m",
    "granularity": "15m"
  }
}
EOF

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources"

payload = {
    "name": "Logs",
    "kind": "log",
    "connection": "507f1f77bcf86cd799439012",
    "from": {
        "databaseName": "otel",
        "tableName": "otel_logs"
    },
    "defaultTableSelectExpression": "Timestamp, ServiceName, SeverityText, Body",
    "timestampValueExpression": "Timestamp",
    "id": "507f1f77bcf86cd799439011",
    "section": "Billing",
    "disabled": False,
    "querySettings": [
        {
            "setting": "max_threads",
            "value": "4"
        }
    ],
    "filterSettings": {
        "databaseName": "default",
        "tableName": "otel_logs",
        "columns": [
            {
                "name": "ServiceName",
                "label": "Service Name",
                "valueExpression": "lower(service_name)",
                "allowAll": False
            }
        ]
    },
    "serviceNameExpression": "ServiceName",
    "serviceVersionExpression": "ResourceAttributes['service.version']",
    "severityTextExpression": "SeverityText",
    "severityNumberExpression": "SeverityNumber",
    "bodyExpression": "Body",
    "eventNameExpression": "EventName",
    "eventAttributesExpression": "LogAttributes",
    "resourceAttributesExpression": "ResourceAttributes",
    "displayedTimestampValueExpression": "TimestampTime",
    "orderByExpression": "Timestamp DESC",
    "metricSourceId": "507f1f77bcf86cd799439013",
    "traceSourceId": "507f1f77bcf86cd799439014",
    "traceIdExpression": "TraceId",
    "spanIdExpression": "SpanId",
    "implicitColumnExpression": "Body",
    "knownColumnsListExpression": "Timestamp, Body, ServiceName",
    "useTextIndexForImplicitColumn": "auto",
    "highlightedTraceAttributeExpressions": [
        {
            "sqlExpression": "SpanAttributes['http.status_code']",
            "luceneExpression": "http.status_code",
            "alias": "HTTP Status Code"
        }
    ],
    "highlightedRowAttributeExpressions": [
        {
            "sqlExpression": "SpanAttributes['http.status_code']",
            "luceneExpression": "http.status_code",
            "alias": "HTTP Status Code"
        }
    ],
    "materializedViews": [
        {
            "databaseName": "otel",
            "tableName": "otel_logs_mv_5m",
            "dimensionColumns": "ServiceName, SeverityText",
            "minGranularity": "5m",
            "timestampColumn": "Timestamp",
            "aggregatedColumns": [
                {
                    "aggFn": "sum",
                    "mvColumn": "sum__Duration",
                    "sourceColumn": "Duration"
                }
            ],
            "minDate": "2025-01-01T00:00:00Z"
        }
    ],
    "metadataMaterializedViews": {
        "keyRollupTable": "otel_logs_key_rollup_15m",
        "kvRollupTable": "otel_logs_kv_rollup_15m",
        "granularity": "15m"
    }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Logs',
    kind: 'log',
    connection: '507f1f77bcf86cd799439012',
    from: {databaseName: 'otel', tableName: 'otel_logs'},
    defaultTableSelectExpression: 'Timestamp, ServiceName, SeverityText, Body',
    timestampValueExpression: 'Timestamp',
    id: '507f1f77bcf86cd799439011',
    section: 'Billing',
    disabled: false,
    querySettings: [{setting: 'max_threads', value: '4'}],
    filterSettings: {
      databaseName: 'default',
      tableName: 'otel_logs',
      columns: [
        {
          name: 'ServiceName',
          label: 'Service Name',
          valueExpression: 'lower(service_name)',
          allowAll: false
        }
      ]
    },
    serviceNameExpression: 'ServiceName',
    serviceVersionExpression: 'ResourceAttributes[\'service.version\']',
    severityTextExpression: 'SeverityText',
    severityNumberExpression: 'SeverityNumber',
    bodyExpression: 'Body',
    eventNameExpression: 'EventName',
    eventAttributesExpression: 'LogAttributes',
    resourceAttributesExpression: 'ResourceAttributes',
    displayedTimestampValueExpression: 'TimestampTime',
    orderByExpression: 'Timestamp DESC',
    metricSourceId: '507f1f77bcf86cd799439013',
    traceSourceId: '507f1f77bcf86cd799439014',
    traceIdExpression: 'TraceId',
    spanIdExpression: 'SpanId',
    implicitColumnExpression: 'Body',
    knownColumnsListExpression: 'Timestamp, Body, ServiceName',
    useTextIndexForImplicitColumn: 'auto',
    highlightedTraceAttributeExpressions: [
      {
        sqlExpression: 'SpanAttributes[\'http.status_code\']',
        luceneExpression: 'http.status_code',
        alias: 'HTTP Status Code'
      }
    ],
    highlightedRowAttributeExpressions: [
      {
        sqlExpression: 'SpanAttributes[\'http.status_code\']',
        luceneExpression: 'http.status_code',
        alias: 'HTTP Status Code'
      }
    ],
    materializedViews: [
      {
        databaseName: 'otel',
        tableName: 'otel_logs_mv_5m',
        dimensionColumns: 'ServiceName, SeverityText',
        minGranularity: '5m',
        timestampColumn: 'Timestamp',
        aggregatedColumns: [{aggFn: 'sum', mvColumn: 'sum__Duration', sourceColumn: 'Duration'}],
        minDate: '2025-01-01T00:00:00Z'
      }
    ],
    metadataMaterializedViews: {
      keyRollupTable: 'otel_logs_key_rollup_15m',
      kvRollupTable: 'otel_logs_kv_rollup_15m',
      granularity: '15m'
    }
  })
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Logs',
    'kind' => 'log',
    'connection' => '507f1f77bcf86cd799439012',
    'from' => [
        'databaseName' => 'otel',
        'tableName' => 'otel_logs'
    ],
    'defaultTableSelectExpression' => 'Timestamp, ServiceName, SeverityText, Body',
    'timestampValueExpression' => 'Timestamp',
    'id' => '507f1f77bcf86cd799439011',
    'section' => 'Billing',
    'disabled' => false,
    'querySettings' => [
        [
                'setting' => 'max_threads',
                'value' => '4'
        ]
    ],
    'filterSettings' => [
        'databaseName' => 'default',
        'tableName' => 'otel_logs',
        'columns' => [
                [
                                'name' => 'ServiceName',
                                'label' => 'Service Name',
                                'valueExpression' => 'lower(service_name)',
                                'allowAll' => false
                ]
        ]
    ],
    'serviceNameExpression' => 'ServiceName',
    'serviceVersionExpression' => 'ResourceAttributes[\'service.version\']',
    'severityTextExpression' => 'SeverityText',
    'severityNumberExpression' => 'SeverityNumber',
    'bodyExpression' => 'Body',
    'eventNameExpression' => 'EventName',
    'eventAttributesExpression' => 'LogAttributes',
    'resourceAttributesExpression' => 'ResourceAttributes',
    'displayedTimestampValueExpression' => 'TimestampTime',
    'orderByExpression' => 'Timestamp DESC',
    'metricSourceId' => '507f1f77bcf86cd799439013',
    'traceSourceId' => '507f1f77bcf86cd799439014',
    'traceIdExpression' => 'TraceId',
    'spanIdExpression' => 'SpanId',
    'implicitColumnExpression' => 'Body',
    'knownColumnsListExpression' => 'Timestamp, Body, ServiceName',
    'useTextIndexForImplicitColumn' => 'auto',
    'highlightedTraceAttributeExpressions' => [
        [
                'sqlExpression' => 'SpanAttributes[\'http.status_code\']',
                'luceneExpression' => 'http.status_code',
                'alias' => 'HTTP Status Code'
        ]
    ],
    'highlightedRowAttributeExpressions' => [
        [
                'sqlExpression' => 'SpanAttributes[\'http.status_code\']',
                'luceneExpression' => 'http.status_code',
                'alias' => 'HTTP Status Code'
        ]
    ],
    'materializedViews' => [
        [
                'databaseName' => 'otel',
                'tableName' => 'otel_logs_mv_5m',
                'dimensionColumns' => 'ServiceName, SeverityText',
                'minGranularity' => '5m',
                'timestampColumn' => 'Timestamp',
                'aggregatedColumns' => [
                                [
                                                                'aggFn' => 'sum',
                                                                'mvColumn' => 'sum__Duration',
                                                                'sourceColumn' => 'Duration'
                                ]
                ],
                'minDate' => '2025-01-01T00:00:00Z'
        ]
    ],
    'metadataMaterializedViews' => [
        'keyRollupTable' => 'otel_logs_key_rollup_15m',
        'kvRollupTable' => 'otel_logs_kv_rollup_15m',
        'granularity' => '15m'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources"

	payload := strings.NewReader("{\n  \"name\": \"Logs\",\n  \"kind\": \"log\",\n  \"connection\": \"507f1f77bcf86cd799439012\",\n  \"from\": {\n    \"databaseName\": \"otel\",\n    \"tableName\": \"otel_logs\"\n  },\n  \"defaultTableSelectExpression\": \"Timestamp, ServiceName, SeverityText, Body\",\n  \"timestampValueExpression\": \"Timestamp\",\n  \"id\": \"507f1f77bcf86cd799439011\",\n  \"section\": \"Billing\",\n  \"disabled\": false,\n  \"querySettings\": [\n    {\n      \"setting\": \"max_threads\",\n      \"value\": \"4\"\n    }\n  ],\n  \"filterSettings\": {\n    \"databaseName\": \"default\",\n    \"tableName\": \"otel_logs\",\n    \"columns\": [\n      {\n        \"name\": \"ServiceName\",\n        \"label\": \"Service Name\",\n        \"valueExpression\": \"lower(service_name)\",\n        \"allowAll\": false\n      }\n    ]\n  },\n  \"serviceNameExpression\": \"ServiceName\",\n  \"serviceVersionExpression\": \"ResourceAttributes['service.version']\",\n  \"severityTextExpression\": \"SeverityText\",\n  \"severityNumberExpression\": \"SeverityNumber\",\n  \"bodyExpression\": \"Body\",\n  \"eventNameExpression\": \"EventName\",\n  \"eventAttributesExpression\": \"LogAttributes\",\n  \"resourceAttributesExpression\": \"ResourceAttributes\",\n  \"displayedTimestampValueExpression\": \"TimestampTime\",\n  \"orderByExpression\": \"Timestamp DESC\",\n  \"metricSourceId\": \"507f1f77bcf86cd799439013\",\n  \"traceSourceId\": \"507f1f77bcf86cd799439014\",\n  \"traceIdExpression\": \"TraceId\",\n  \"spanIdExpression\": \"SpanId\",\n  \"implicitColumnExpression\": \"Body\",\n  \"knownColumnsListExpression\": \"Timestamp, Body, ServiceName\",\n  \"useTextIndexForImplicitColumn\": \"auto\",\n  \"highlightedTraceAttributeExpressions\": [\n    {\n      \"sqlExpression\": \"SpanAttributes['http.status_code']\",\n      \"luceneExpression\": \"http.status_code\",\n      \"alias\": \"HTTP Status Code\"\n    }\n  ],\n  \"highlightedRowAttributeExpressions\": [\n    {\n      \"sqlExpression\": \"SpanAttributes['http.status_code']\",\n      \"luceneExpression\": \"http.status_code\",\n      \"alias\": \"HTTP Status Code\"\n    }\n  ],\n  \"materializedViews\": [\n    {\n      \"databaseName\": \"otel\",\n      \"tableName\": \"otel_logs_mv_5m\",\n      \"dimensionColumns\": \"ServiceName, SeverityText\",\n      \"minGranularity\": \"5m\",\n      \"timestampColumn\": \"Timestamp\",\n      \"aggregatedColumns\": [\n        {\n          \"aggFn\": \"sum\",\n          \"mvColumn\": \"sum__Duration\",\n          \"sourceColumn\": \"Duration\"\n        }\n      ],\n      \"minDate\": \"2025-01-01T00:00:00Z\"\n    }\n  ],\n  \"metadataMaterializedViews\": {\n    \"keyRollupTable\": \"otel_logs_key_rollup_15m\",\n    \"kvRollupTable\": \"otel_logs_kv_rollup_15m\",\n    \"granularity\": \"15m\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Logs\",\n  \"kind\": \"log\",\n  \"connection\": \"507f1f77bcf86cd799439012\",\n  \"from\": {\n    \"databaseName\": \"otel\",\n    \"tableName\": \"otel_logs\"\n  },\n  \"defaultTableSelectExpression\": \"Timestamp, ServiceName, SeverityText, Body\",\n  \"timestampValueExpression\": \"Timestamp\",\n  \"id\": \"507f1f77bcf86cd799439011\",\n  \"section\": \"Billing\",\n  \"disabled\": false,\n  \"querySettings\": [\n    {\n      \"setting\": \"max_threads\",\n      \"value\": \"4\"\n    }\n  ],\n  \"filterSettings\": {\n    \"databaseName\": \"default\",\n    \"tableName\": \"otel_logs\",\n    \"columns\": [\n      {\n        \"name\": \"ServiceName\",\n        \"label\": \"Service Name\",\n        \"valueExpression\": \"lower(service_name)\",\n        \"allowAll\": false\n      }\n    ]\n  },\n  \"serviceNameExpression\": \"ServiceName\",\n  \"serviceVersionExpression\": \"ResourceAttributes['service.version']\",\n  \"severityTextExpression\": \"SeverityText\",\n  \"severityNumberExpression\": \"SeverityNumber\",\n  \"bodyExpression\": \"Body\",\n  \"eventNameExpression\": \"EventName\",\n  \"eventAttributesExpression\": \"LogAttributes\",\n  \"resourceAttributesExpression\": \"ResourceAttributes\",\n  \"displayedTimestampValueExpression\": \"TimestampTime\",\n  \"orderByExpression\": \"Timestamp DESC\",\n  \"metricSourceId\": \"507f1f77bcf86cd799439013\",\n  \"traceSourceId\": \"507f1f77bcf86cd799439014\",\n  \"traceIdExpression\": \"TraceId\",\n  \"spanIdExpression\": \"SpanId\",\n  \"implicitColumnExpression\": \"Body\",\n  \"knownColumnsListExpression\": \"Timestamp, Body, ServiceName\",\n  \"useTextIndexForImplicitColumn\": \"auto\",\n  \"highlightedTraceAttributeExpressions\": [\n    {\n      \"sqlExpression\": \"SpanAttributes['http.status_code']\",\n      \"luceneExpression\": \"http.status_code\",\n      \"alias\": \"HTTP Status Code\"\n    }\n  ],\n  \"highlightedRowAttributeExpressions\": [\n    {\n      \"sqlExpression\": \"SpanAttributes['http.status_code']\",\n      \"luceneExpression\": \"http.status_code\",\n      \"alias\": \"HTTP Status Code\"\n    }\n  ],\n  \"materializedViews\": [\n    {\n      \"databaseName\": \"otel\",\n      \"tableName\": \"otel_logs_mv_5m\",\n      \"dimensionColumns\": \"ServiceName, SeverityText\",\n      \"minGranularity\": \"5m\",\n      \"timestampColumn\": \"Timestamp\",\n      \"aggregatedColumns\": [\n        {\n          \"aggFn\": \"sum\",\n          \"mvColumn\": \"sum__Duration\",\n          \"sourceColumn\": \"Duration\"\n        }\n      ],\n      \"minDate\": \"2025-01-01T00:00:00Z\"\n    }\n  ],\n  \"metadataMaterializedViews\": {\n    \"keyRollupTable\": \"otel_logs_key_rollup_15m\",\n    \"kvRollupTable\": \"otel_logs_kv_rollup_15m\",\n    \"granularity\": \"15m\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Logs\",\n  \"kind\": \"log\",\n  \"connection\": \"507f1f77bcf86cd799439012\",\n  \"from\": {\n    \"databaseName\": \"otel\",\n    \"tableName\": \"otel_logs\"\n  },\n  \"defaultTableSelectExpression\": \"Timestamp, ServiceName, SeverityText, Body\",\n  \"timestampValueExpression\": \"Timestamp\",\n  \"id\": \"507f1f77bcf86cd799439011\",\n  \"section\": \"Billing\",\n  \"disabled\": false,\n  \"querySettings\": [\n    {\n      \"setting\": \"max_threads\",\n      \"value\": \"4\"\n    }\n  ],\n  \"filterSettings\": {\n    \"databaseName\": \"default\",\n    \"tableName\": \"otel_logs\",\n    \"columns\": [\n      {\n        \"name\": \"ServiceName\",\n        \"label\": \"Service Name\",\n        \"valueExpression\": \"lower(service_name)\",\n        \"allowAll\": false\n      }\n    ]\n  },\n  \"serviceNameExpression\": \"ServiceName\",\n  \"serviceVersionExpression\": \"ResourceAttributes['service.version']\",\n  \"severityTextExpression\": \"SeverityText\",\n  \"severityNumberExpression\": \"SeverityNumber\",\n  \"bodyExpression\": \"Body\",\n  \"eventNameExpression\": \"EventName\",\n  \"eventAttributesExpression\": \"LogAttributes\",\n  \"resourceAttributesExpression\": \"ResourceAttributes\",\n  \"displayedTimestampValueExpression\": \"TimestampTime\",\n  \"orderByExpression\": \"Timestamp DESC\",\n  \"metricSourceId\": \"507f1f77bcf86cd799439013\",\n  \"traceSourceId\": \"507f1f77bcf86cd799439014\",\n  \"traceIdExpression\": \"TraceId\",\n  \"spanIdExpression\": \"SpanId\",\n  \"implicitColumnExpression\": \"Body\",\n  \"knownColumnsListExpression\": \"Timestamp, Body, ServiceName\",\n  \"useTextIndexForImplicitColumn\": \"auto\",\n  \"highlightedTraceAttributeExpressions\": [\n    {\n      \"sqlExpression\": \"SpanAttributes['http.status_code']\",\n      \"luceneExpression\": \"http.status_code\",\n      \"alias\": \"HTTP Status Code\"\n    }\n  ],\n  \"highlightedRowAttributeExpressions\": [\n    {\n      \"sqlExpression\": \"SpanAttributes['http.status_code']\",\n      \"luceneExpression\": \"http.status_code\",\n      \"alias\": \"HTTP Status Code\"\n    }\n  ],\n  \"materializedViews\": [\n    {\n      \"databaseName\": \"otel\",\n      \"tableName\": \"otel_logs_mv_5m\",\n      \"dimensionColumns\": \"ServiceName, SeverityText\",\n      \"minGranularity\": \"5m\",\n      \"timestampColumn\": \"Timestamp\",\n      \"aggregatedColumns\": [\n        {\n          \"aggFn\": \"sum\",\n          \"mvColumn\": \"sum__Duration\",\n          \"sourceColumn\": \"Duration\"\n        }\n      ],\n      \"minDate\": \"2025-01-01T00:00:00Z\"\n    }\n  ],\n  \"metadataMaterializedViews\": {\n    \"keyRollupTable\": \"otel_logs_key_rollup_15m\",\n    \"kvRollupTable\": \"otel_logs_kv_rollup_15m\",\n    \"granularity\": \"15m\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "name": "Logs",
    "kind": "log",
    "connection": "507f1f77bcf86cd799439012",
    "from": {
      "databaseName": "otel",
      "tableName": "otel_logs"
    },
    "defaultTableSelectExpression": "Timestamp, ServiceName, SeverityText, Body",
    "timestampValueExpression": "Timestamp",
    "id": "507f1f77bcf86cd799439011",
    "section": "Billing",
    "disabled": false,
    "querySettings": [
      {
        "setting": "max_threads",
        "value": "4"
      }
    ],
    "filterSettings": {
      "databaseName": "default",
      "tableName": "otel_logs",
      "columns": [
        {
          "name": "ServiceName",
          "label": "Service Name",
          "valueExpression": "lower(service_name)",
          "allowAll": false
        }
      ]
    },
    "serviceNameExpression": "ServiceName",
    "serviceVersionExpression": "ResourceAttributes['service.version']",
    "severityTextExpression": "SeverityText",
    "severityNumberExpression": "SeverityNumber",
    "bodyExpression": "Body",
    "eventNameExpression": "EventName",
    "eventAttributesExpression": "LogAttributes",
    "resourceAttributesExpression": "ResourceAttributes",
    "displayedTimestampValueExpression": "TimestampTime",
    "orderByExpression": "Timestamp DESC",
    "metricSourceId": "507f1f77bcf86cd799439013",
    "traceSourceId": "507f1f77bcf86cd799439014",
    "traceIdExpression": "TraceId",
    "spanIdExpression": "SpanId",
    "implicitColumnExpression": "Body",
    "knownColumnsListExpression": "Timestamp, Body, ServiceName",
    "useTextIndexForImplicitColumn": "auto",
    "highlightedTraceAttributeExpressions": [
      {
        "sqlExpression": "SpanAttributes['http.status_code']",
        "luceneExpression": "http.status_code",
        "alias": "HTTP Status Code"
      }
    ],
    "highlightedRowAttributeExpressions": [
      {
        "sqlExpression": "SpanAttributes['http.status_code']",
        "luceneExpression": "http.status_code",
        "alias": "HTTP Status Code"
      }
    ],
    "materializedViews": [
      {
        "databaseName": "otel",
        "tableName": "otel_logs_mv_5m",
        "dimensionColumns": "ServiceName, SeverityText",
        "minGranularity": "5m",
        "timestampColumn": "Timestamp",
        "aggregatedColumns": [
          {
            "aggFn": "sum",
            "mvColumn": "sum__Duration",
            "sourceColumn": "Duration"
          }
        ],
        "minDate": "2025-01-01T00:00:00Z"
      }
    ],
    "metadataMaterializedViews": {
      "keyRollupTable": "otel_logs_key_rollup_15m",
      "kvRollupTable": "otel_logs_kv_rollup_15m",
      "granularity": "15m"
    }
  }
}

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Beta This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

ClickStack: Creates a new source. The request body is a source object without the id field. If an id is sent anyway it is silently ignored (stripped before validation — the request is never rejected because of it). Granularity fields (materializedViews[].minGranularity and metadataMaterializedViews.granularity) accept the same short format the API returns (e.g. 5m, 15s, 1h, 1d).

Permission

The API key must have the control-plane:service:manage-clickstack-api permission.

Authorizations

Authorization

string

header

required

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path Parameters

organizationId

string<uuid>

required

ID of the organization that owns the service.

serviceId

string<uuid>

required

ID of the ClickStack service.

Body

application/json

Option 1
Option 2
Option 3
Option 4
Option 5

name

string

required

Display name for the source.

Example:

"Logs"

kind

enum<string>

required

Source kind discriminator. Must be "log" for log sources.

Available options:

log

Example:

"log"

connection

string

required

ID of the ClickHouse connection used by this source.

Example:

"507f1f77bcf86cd799439012"

from

object

required

Show child attributes

defaultTableSelectExpression

string

required

Default columns selected in search results (this can be customized per search later)

Example:

"Timestamp, ServiceName, SeverityText, Body"

timestampValueExpression

string

required

DateTime column or expression that is part of your table's primary key.

Example:

"Timestamp"

string

Unique source ID. Server-generated; ignored if sent in create/update requests.

Example:

"507f1f77bcf86cd799439011"

section

string

Optional grouping label used to organize sources in the source selector. Sources that share a section value are displayed together.

Example:

"Billing"

disabled

boolean | null

When true, the source is hidden from source selectors in the UI. Defaults to false.

Example:

false

querySettings

object[]

Optional ClickHouse query settings applied when querying this source.

Show child attributes

filterSettings

object | null

Show child attributes

serviceNameExpression

string | null

Expression to extract the service name from log rows.

Example:

"ServiceName"

serviceVersionExpression

string | null

Expression identifying the running release of a service. Defaults to the OpenTelemetry service.version resource attribute when unset. Where services carry the release on different attributes, fall back across them with coalesce(nullIf(a, ''), nullIf(b, '')).

Example:

"ResourceAttributes['service.version']"

severityTextExpression

string | null

Expression to extract the severity/log level text.

Example:

"SeverityText"

severityNumberExpression

string | null

Expression for the numeric OpenTelemetry SeverityNumber (1-24).

Example:

"SeverityNumber"

bodyExpression

string | null

Expression to extract the log message body.

Example:

"Body"

eventNameExpression

string | null

Expression for the OpenTelemetry log EventName.

Example:

"EventName"

eventAttributesExpression

string | null

Expression to extract event-level attributes.

Example:

"LogAttributes"

resourceAttributesExpression

string | null

Expression to extract resource-level attributes.

Example:

"ResourceAttributes"

displayedTimestampValueExpression

string | null

This DateTime column is used to display and order search results.

Example:

"TimestampTime"

orderByExpression

string

Custom ORDER BY expression that overrides the default ordering. Leave empty to use the auto-detected default.

Example:

"Timestamp DESC"

metricSourceId

string | null

HyperDX Source for metrics associated with logs. Optional

Example:

"507f1f77bcf86cd799439013"

traceSourceId

string | null

HyperDX Source for traces associated with logs. Optional

Example:

"507f1f77bcf86cd799439014"

traceIdExpression

string | null

Expression to extract the trace ID for correlating logs with traces.

Example:

"TraceId"

spanIdExpression

string | null

Expression to extract the span ID for correlating logs with traces.

Example:

"SpanId"

implicitColumnExpression

string | null

Column used for full text search if no property is specified in a Lucene-based search. Typically the message body of a log.

Example:

"Body"

knownColumnsListExpression

string | null

For Distributed table sources whose target tables have non-matching column sets. A list of columns supported across all target tables, used instead of SELECT * when fetching full row data. Leave blank to select all columns.

Example:

"Timestamp, Body, ServiceName"

useTextIndexForImplicitColumn

enum<string> | null

Controls whether lucene rendering uses ClickHouse text indices via hasAllTokens() against the implicit column. "auto" detects a covering index at query time, "enabled" forces text index usage, "disabled" forces a LIKE/hasToken fallback.

Available options:

auto,

enabled,

disabled

Example:

"auto"

highlightedTraceAttributeExpressions

object[]

Expressions defining trace-level attributes which are displayed in the trace view for the selected trace.

Show child attributes

highlightedRowAttributeExpressions

object[]

Expressions defining row-level attributes which are displayed in the row side panel for the selected row.

Show child attributes

materializedViews

object[]

Configure materialized views for query optimization. These pre-aggregated views can significantly improve query performance on aggregation queries.

Show child attributes

metadataMaterializedViews

object | null

Show child attributes

Response

Successful response

status

number

HTTP status code.

Example:

200

requestId

string<uuid>

Unique id assigned to every request. UUIDv4

result

object

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

ClickStack: Create Source

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "name": "Logs",
  "kind": "log",
  "connection": "507f1f77bcf86cd799439012",
  "from": {
    "databaseName": "otel",
    "tableName": "otel_logs"
  },
  "defaultTableSelectExpression": "Timestamp, ServiceName, SeverityText, Body",
  "timestampValueExpression": "Timestamp",
  "id": "507f1f77bcf86cd799439011",
  "section": "Billing",
  "disabled": false,
  "querySettings": [
    {
      "setting": "max_threads",
      "value": "4"
    }
  ],
  "filterSettings": {
    "databaseName": "default",
    "tableName": "otel_logs",
    "columns": [
      {
        "name": "ServiceName",
        "label": "Service Name",
        "valueExpression": "lower(service_name)",
        "allowAll": false
      }
    ]
  },
  "serviceNameExpression": "ServiceName",
  "serviceVersionExpression": "ResourceAttributes['service.version']",
  "severityTextExpression": "SeverityText",
  "severityNumberExpression": "SeverityNumber",
  "bodyExpression": "Body",
  "eventNameExpression": "EventName",
  "eventAttributesExpression": "LogAttributes",
  "resourceAttributesExpression": "ResourceAttributes",
  "displayedTimestampValueExpression": "TimestampTime",
  "orderByExpression": "Timestamp DESC",
  "metricSourceId": "507f1f77bcf86cd799439013",
  "traceSourceId": "507f1f77bcf86cd799439014",
  "traceIdExpression": "TraceId",
  "spanIdExpression": "SpanId",
  "implicitColumnExpression": "Body",
  "knownColumnsListExpression": "Timestamp, Body, ServiceName",
  "useTextIndexForImplicitColumn": "auto",
  "highlightedTraceAttributeExpressions": [
    {
      "sqlExpression": "SpanAttributes['http.status_code']",
      "luceneExpression": "http.status_code",
      "alias": "HTTP Status Code"
    }
  ],
  "highlightedRowAttributeExpressions": [
    {
      "sqlExpression": "SpanAttributes['http.status_code']",
      "luceneExpression": "http.status_code",
      "alias": "HTTP Status Code"
    }
  ],
  "materializedViews": [
    {
      "databaseName": "otel",
      "tableName": "otel_logs_mv_5m",
      "dimensionColumns": "ServiceName, SeverityText",
      "minGranularity": "5m",
      "timestampColumn": "Timestamp",
      "aggregatedColumns": [
        {
          "aggFn": "sum",
          "mvColumn": "sum__Duration",
          "sourceColumn": "Duration"
        }
      ],
      "minDate": "2025-01-01T00:00:00Z"
    }
  ],
  "metadataMaterializedViews": {
    "keyRollupTable": "otel_logs_key_rollup_15m",
    "kvRollupTable": "otel_logs_kv_rollup_15m",
    "granularity": "15m"
  }
}
EOF

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources"

payload = {
    "name": "Logs",
    "kind": "log",
    "connection": "507f1f77bcf86cd799439012",
    "from": {
        "databaseName": "otel",
        "tableName": "otel_logs"
    },
    "defaultTableSelectExpression": "Timestamp, ServiceName, SeverityText, Body",
    "timestampValueExpression": "Timestamp",
    "id": "507f1f77bcf86cd799439011",
    "section": "Billing",
    "disabled": False,
    "querySettings": [
        {
            "setting": "max_threads",
            "value": "4"
        }
    ],
    "filterSettings": {
        "databaseName": "default",
        "tableName": "otel_logs",
        "columns": [
            {
                "name": "ServiceName",
                "label": "Service Name",
                "valueExpression": "lower(service_name)",
                "allowAll": False
            }
        ]
    },
    "serviceNameExpression": "ServiceName",
    "serviceVersionExpression": "ResourceAttributes['service.version']",
    "severityTextExpression": "SeverityText",
    "severityNumberExpression": "SeverityNumber",
    "bodyExpression": "Body",
    "eventNameExpression": "EventName",
    "eventAttributesExpression": "LogAttributes",
    "resourceAttributesExpression": "ResourceAttributes",
    "displayedTimestampValueExpression": "TimestampTime",
    "orderByExpression": "Timestamp DESC",
    "metricSourceId": "507f1f77bcf86cd799439013",
    "traceSourceId": "507f1f77bcf86cd799439014",
    "traceIdExpression": "TraceId",
    "spanIdExpression": "SpanId",
    "implicitColumnExpression": "Body",
    "knownColumnsListExpression": "Timestamp, Body, ServiceName",
    "useTextIndexForImplicitColumn": "auto",
    "highlightedTraceAttributeExpressions": [
        {
            "sqlExpression": "SpanAttributes['http.status_code']",
            "luceneExpression": "http.status_code",
            "alias": "HTTP Status Code"
        }
    ],
    "highlightedRowAttributeExpressions": [
        {
            "sqlExpression": "SpanAttributes['http.status_code']",
            "luceneExpression": "http.status_code",
            "alias": "HTTP Status Code"
        }
    ],
    "materializedViews": [
        {
            "databaseName": "otel",
            "tableName": "otel_logs_mv_5m",
            "dimensionColumns": "ServiceName, SeverityText",
            "minGranularity": "5m",
            "timestampColumn": "Timestamp",
            "aggregatedColumns": [
                {
                    "aggFn": "sum",
                    "mvColumn": "sum__Duration",
                    "sourceColumn": "Duration"
                }
            ],
            "minDate": "2025-01-01T00:00:00Z"
        }
    ],
    "metadataMaterializedViews": {
        "keyRollupTable": "otel_logs_key_rollup_15m",
        "kvRollupTable": "otel_logs_kv_rollup_15m",
        "granularity": "15m"
    }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Logs',
    kind: 'log',
    connection: '507f1f77bcf86cd799439012',
    from: {databaseName: 'otel', tableName: 'otel_logs'},
    defaultTableSelectExpression: 'Timestamp, ServiceName, SeverityText, Body',
    timestampValueExpression: 'Timestamp',
    id: '507f1f77bcf86cd799439011',
    section: 'Billing',
    disabled: false,
    querySettings: [{setting: 'max_threads', value: '4'}],
    filterSettings: {
      databaseName: 'default',
      tableName: 'otel_logs',
      columns: [
        {
          name: 'ServiceName',
          label: 'Service Name',
          valueExpression: 'lower(service_name)',
          allowAll: false
        }
      ]
    },
    serviceNameExpression: 'ServiceName',
    serviceVersionExpression: 'ResourceAttributes[\'service.version\']',
    severityTextExpression: 'SeverityText',
    severityNumberExpression: 'SeverityNumber',
    bodyExpression: 'Body',
    eventNameExpression: 'EventName',
    eventAttributesExpression: 'LogAttributes',
    resourceAttributesExpression: 'ResourceAttributes',
    displayedTimestampValueExpression: 'TimestampTime',
    orderByExpression: 'Timestamp DESC',
    metricSourceId: '507f1f77bcf86cd799439013',
    traceSourceId: '507f1f77bcf86cd799439014',
    traceIdExpression: 'TraceId',
    spanIdExpression: 'SpanId',
    implicitColumnExpression: 'Body',
    knownColumnsListExpression: 'Timestamp, Body, ServiceName',
    useTextIndexForImplicitColumn: 'auto',
    highlightedTraceAttributeExpressions: [
      {
        sqlExpression: 'SpanAttributes[\'http.status_code\']',
        luceneExpression: 'http.status_code',
        alias: 'HTTP Status Code'
      }
    ],
    highlightedRowAttributeExpressions: [
      {
        sqlExpression: 'SpanAttributes[\'http.status_code\']',
        luceneExpression: 'http.status_code',
        alias: 'HTTP Status Code'
      }
    ],
    materializedViews: [
      {
        databaseName: 'otel',
        tableName: 'otel_logs_mv_5m',
        dimensionColumns: 'ServiceName, SeverityText',
        minGranularity: '5m',
        timestampColumn: 'Timestamp',
        aggregatedColumns: [{aggFn: 'sum', mvColumn: 'sum__Duration', sourceColumn: 'Duration'}],
        minDate: '2025-01-01T00:00:00Z'
      }
    ],
    metadataMaterializedViews: {
      keyRollupTable: 'otel_logs_key_rollup_15m',
      kvRollupTable: 'otel_logs_kv_rollup_15m',
      granularity: '15m'
    }
  })
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Logs',
    'kind' => 'log',
    'connection' => '507f1f77bcf86cd799439012',
    'from' => [
        'databaseName' => 'otel',
        'tableName' => 'otel_logs'
    ],
    'defaultTableSelectExpression' => 'Timestamp, ServiceName, SeverityText, Body',
    'timestampValueExpression' => 'Timestamp',
    'id' => '507f1f77bcf86cd799439011',
    'section' => 'Billing',
    'disabled' => false,
    'querySettings' => [
        [
                'setting' => 'max_threads',
                'value' => '4'
        ]
    ],
    'filterSettings' => [
        'databaseName' => 'default',
        'tableName' => 'otel_logs',
        'columns' => [
                [
                                'name' => 'ServiceName',
                                'label' => 'Service Name',
                                'valueExpression' => 'lower(service_name)',
                                'allowAll' => false
                ]
        ]
    ],
    'serviceNameExpression' => 'ServiceName',
    'serviceVersionExpression' => 'ResourceAttributes[\'service.version\']',
    'severityTextExpression' => 'SeverityText',
    'severityNumberExpression' => 'SeverityNumber',
    'bodyExpression' => 'Body',
    'eventNameExpression' => 'EventName',
    'eventAttributesExpression' => 'LogAttributes',
    'resourceAttributesExpression' => 'ResourceAttributes',
    'displayedTimestampValueExpression' => 'TimestampTime',
    'orderByExpression' => 'Timestamp DESC',
    'metricSourceId' => '507f1f77bcf86cd799439013',
    'traceSourceId' => '507f1f77bcf86cd799439014',
    'traceIdExpression' => 'TraceId',
    'spanIdExpression' => 'SpanId',
    'implicitColumnExpression' => 'Body',
    'knownColumnsListExpression' => 'Timestamp, Body, ServiceName',
    'useTextIndexForImplicitColumn' => 'auto',
    'highlightedTraceAttributeExpressions' => [
        [
                'sqlExpression' => 'SpanAttributes[\'http.status_code\']',
                'luceneExpression' => 'http.status_code',
                'alias' => 'HTTP Status Code'
        ]
    ],
    'highlightedRowAttributeExpressions' => [
        [
                'sqlExpression' => 'SpanAttributes[\'http.status_code\']',
                'luceneExpression' => 'http.status_code',
                'alias' => 'HTTP Status Code'
        ]
    ],
    'materializedViews' => [
        [
                'databaseName' => 'otel',
                'tableName' => 'otel_logs_mv_5m',
                'dimensionColumns' => 'ServiceName, SeverityText',
                'minGranularity' => '5m',
                'timestampColumn' => 'Timestamp',
                'aggregatedColumns' => [
                                [
                                                                'aggFn' => 'sum',
                                                                'mvColumn' => 'sum__Duration',
                                                                'sourceColumn' => 'Duration'
                                ]
                ],
                'minDate' => '2025-01-01T00:00:00Z'
        ]
    ],
    'metadataMaterializedViews' => [
        'keyRollupTable' => 'otel_logs_key_rollup_15m',
        'kvRollupTable' => 'otel_logs_kv_rollup_15m',
        'granularity' => '15m'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources"

	payload := strings.NewReader("{\n  \"name\": \"Logs\",\n  \"kind\": \"log\",\n  \"connection\": \"507f1f77bcf86cd799439012\",\n  \"from\": {\n    \"databaseName\": \"otel\",\n    \"tableName\": \"otel_logs\"\n  },\n  \"defaultTableSelectExpression\": \"Timestamp, ServiceName, SeverityText, Body\",\n  \"timestampValueExpression\": \"Timestamp\",\n  \"id\": \"507f1f77bcf86cd799439011\",\n  \"section\": \"Billing\",\n  \"disabled\": false,\n  \"querySettings\": [\n    {\n      \"setting\": \"max_threads\",\n      \"value\": \"4\"\n    }\n  ],\n  \"filterSettings\": {\n    \"databaseName\": \"default\",\n    \"tableName\": \"otel_logs\",\n    \"columns\": [\n      {\n        \"name\": \"ServiceName\",\n        \"label\": \"Service Name\",\n        \"valueExpression\": \"lower(service_name)\",\n        \"allowAll\": false\n      }\n    ]\n  },\n  \"serviceNameExpression\": \"ServiceName\",\n  \"serviceVersionExpression\": \"ResourceAttributes['service.version']\",\n  \"severityTextExpression\": \"SeverityText\",\n  \"severityNumberExpression\": \"SeverityNumber\",\n  \"bodyExpression\": \"Body\",\n  \"eventNameExpression\": \"EventName\",\n  \"eventAttributesExpression\": \"LogAttributes\",\n  \"resourceAttributesExpression\": \"ResourceAttributes\",\n  \"displayedTimestampValueExpression\": \"TimestampTime\",\n  \"orderByExpression\": \"Timestamp DESC\",\n  \"metricSourceId\": \"507f1f77bcf86cd799439013\",\n  \"traceSourceId\": \"507f1f77bcf86cd799439014\",\n  \"traceIdExpression\": \"TraceId\",\n  \"spanIdExpression\": \"SpanId\",\n  \"implicitColumnExpression\": \"Body\",\n  \"knownColumnsListExpression\": \"Timestamp, Body, ServiceName\",\n  \"useTextIndexForImplicitColumn\": \"auto\",\n  \"highlightedTraceAttributeExpressions\": [\n    {\n      \"sqlExpression\": \"SpanAttributes['http.status_code']\",\n      \"luceneExpression\": \"http.status_code\",\n      \"alias\": \"HTTP Status Code\"\n    }\n  ],\n  \"highlightedRowAttributeExpressions\": [\n    {\n      \"sqlExpression\": \"SpanAttributes['http.status_code']\",\n      \"luceneExpression\": \"http.status_code\",\n      \"alias\": \"HTTP Status Code\"\n    }\n  ],\n  \"materializedViews\": [\n    {\n      \"databaseName\": \"otel\",\n      \"tableName\": \"otel_logs_mv_5m\",\n      \"dimensionColumns\": \"ServiceName, SeverityText\",\n      \"minGranularity\": \"5m\",\n      \"timestampColumn\": \"Timestamp\",\n      \"aggregatedColumns\": [\n        {\n          \"aggFn\": \"sum\",\n          \"mvColumn\": \"sum__Duration\",\n          \"sourceColumn\": \"Duration\"\n        }\n      ],\n      \"minDate\": \"2025-01-01T00:00:00Z\"\n    }\n  ],\n  \"metadataMaterializedViews\": {\n    \"keyRollupTable\": \"otel_logs_key_rollup_15m\",\n    \"kvRollupTable\": \"otel_logs_kv_rollup_15m\",\n    \"granularity\": \"15m\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Logs\",\n  \"kind\": \"log\",\n  \"connection\": \"507f1f77bcf86cd799439012\",\n  \"from\": {\n    \"databaseName\": \"otel\",\n    \"tableName\": \"otel_logs\"\n  },\n  \"defaultTableSelectExpression\": \"Timestamp, ServiceName, SeverityText, Body\",\n  \"timestampValueExpression\": \"Timestamp\",\n  \"id\": \"507f1f77bcf86cd799439011\",\n  \"section\": \"Billing\",\n  \"disabled\": false,\n  \"querySettings\": [\n    {\n      \"setting\": \"max_threads\",\n      \"value\": \"4\"\n    }\n  ],\n  \"filterSettings\": {\n    \"databaseName\": \"default\",\n    \"tableName\": \"otel_logs\",\n    \"columns\": [\n      {\n        \"name\": \"ServiceName\",\n        \"label\": \"Service Name\",\n        \"valueExpression\": \"lower(service_name)\",\n        \"allowAll\": false\n      }\n    ]\n  },\n  \"serviceNameExpression\": \"ServiceName\",\n  \"serviceVersionExpression\": \"ResourceAttributes['service.version']\",\n  \"severityTextExpression\": \"SeverityText\",\n  \"severityNumberExpression\": \"SeverityNumber\",\n  \"bodyExpression\": \"Body\",\n  \"eventNameExpression\": \"EventName\",\n  \"eventAttributesExpression\": \"LogAttributes\",\n  \"resourceAttributesExpression\": \"ResourceAttributes\",\n  \"displayedTimestampValueExpression\": \"TimestampTime\",\n  \"orderByExpression\": \"Timestamp DESC\",\n  \"metricSourceId\": \"507f1f77bcf86cd799439013\",\n  \"traceSourceId\": \"507f1f77bcf86cd799439014\",\n  \"traceIdExpression\": \"TraceId\",\n  \"spanIdExpression\": \"SpanId\",\n  \"implicitColumnExpression\": \"Body\",\n  \"knownColumnsListExpression\": \"Timestamp, Body, ServiceName\",\n  \"useTextIndexForImplicitColumn\": \"auto\",\n  \"highlightedTraceAttributeExpressions\": [\n    {\n      \"sqlExpression\": \"SpanAttributes['http.status_code']\",\n      \"luceneExpression\": \"http.status_code\",\n      \"alias\": \"HTTP Status Code\"\n    }\n  ],\n  \"highlightedRowAttributeExpressions\": [\n    {\n      \"sqlExpression\": \"SpanAttributes['http.status_code']\",\n      \"luceneExpression\": \"http.status_code\",\n      \"alias\": \"HTTP Status Code\"\n    }\n  ],\n  \"materializedViews\": [\n    {\n      \"databaseName\": \"otel\",\n      \"tableName\": \"otel_logs_mv_5m\",\n      \"dimensionColumns\": \"ServiceName, SeverityText\",\n      \"minGranularity\": \"5m\",\n      \"timestampColumn\": \"Timestamp\",\n      \"aggregatedColumns\": [\n        {\n          \"aggFn\": \"sum\",\n          \"mvColumn\": \"sum__Duration\",\n          \"sourceColumn\": \"Duration\"\n        }\n      ],\n      \"minDate\": \"2025-01-01T00:00:00Z\"\n    }\n  ],\n  \"metadataMaterializedViews\": {\n    \"keyRollupTable\": \"otel_logs_key_rollup_15m\",\n    \"kvRollupTable\": \"otel_logs_kv_rollup_15m\",\n    \"granularity\": \"15m\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Logs\",\n  \"kind\": \"log\",\n  \"connection\": \"507f1f77bcf86cd799439012\",\n  \"from\": {\n    \"databaseName\": \"otel\",\n    \"tableName\": \"otel_logs\"\n  },\n  \"defaultTableSelectExpression\": \"Timestamp, ServiceName, SeverityText, Body\",\n  \"timestampValueExpression\": \"Timestamp\",\n  \"id\": \"507f1f77bcf86cd799439011\",\n  \"section\": \"Billing\",\n  \"disabled\": false,\n  \"querySettings\": [\n    {\n      \"setting\": \"max_threads\",\n      \"value\": \"4\"\n    }\n  ],\n  \"filterSettings\": {\n    \"databaseName\": \"default\",\n    \"tableName\": \"otel_logs\",\n    \"columns\": [\n      {\n        \"name\": \"ServiceName\",\n        \"label\": \"Service Name\",\n        \"valueExpression\": \"lower(service_name)\",\n        \"allowAll\": false\n      }\n    ]\n  },\n  \"serviceNameExpression\": \"ServiceName\",\n  \"serviceVersionExpression\": \"ResourceAttributes['service.version']\",\n  \"severityTextExpression\": \"SeverityText\",\n  \"severityNumberExpression\": \"SeverityNumber\",\n  \"bodyExpression\": \"Body\",\n  \"eventNameExpression\": \"EventName\",\n  \"eventAttributesExpression\": \"LogAttributes\",\n  \"resourceAttributesExpression\": \"ResourceAttributes\",\n  \"displayedTimestampValueExpression\": \"TimestampTime\",\n  \"orderByExpression\": \"Timestamp DESC\",\n  \"metricSourceId\": \"507f1f77bcf86cd799439013\",\n  \"traceSourceId\": \"507f1f77bcf86cd799439014\",\n  \"traceIdExpression\": \"TraceId\",\n  \"spanIdExpression\": \"SpanId\",\n  \"implicitColumnExpression\": \"Body\",\n  \"knownColumnsListExpression\": \"Timestamp, Body, ServiceName\",\n  \"useTextIndexForImplicitColumn\": \"auto\",\n  \"highlightedTraceAttributeExpressions\": [\n    {\n      \"sqlExpression\": \"SpanAttributes['http.status_code']\",\n      \"luceneExpression\": \"http.status_code\",\n      \"alias\": \"HTTP Status Code\"\n    }\n  ],\n  \"highlightedRowAttributeExpressions\": [\n    {\n      \"sqlExpression\": \"SpanAttributes['http.status_code']\",\n      \"luceneExpression\": \"http.status_code\",\n      \"alias\": \"HTTP Status Code\"\n    }\n  ],\n  \"materializedViews\": [\n    {\n      \"databaseName\": \"otel\",\n      \"tableName\": \"otel_logs_mv_5m\",\n      \"dimensionColumns\": \"ServiceName, SeverityText\",\n      \"minGranularity\": \"5m\",\n      \"timestampColumn\": \"Timestamp\",\n      \"aggregatedColumns\": [\n        {\n          \"aggFn\": \"sum\",\n          \"mvColumn\": \"sum__Duration\",\n          \"sourceColumn\": \"Duration\"\n        }\n      ],\n      \"minDate\": \"2025-01-01T00:00:00Z\"\n    }\n  ],\n  \"metadataMaterializedViews\": {\n    \"keyRollupTable\": \"otel_logs_key_rollup_15m\",\n    \"kvRollupTable\": \"otel_logs_kv_rollup_15m\",\n    \"granularity\": \"15m\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "name": "Logs",
    "kind": "log",
    "connection": "507f1f77bcf86cd799439012",
    "from": {
      "databaseName": "otel",
      "tableName": "otel_logs"
    },
    "defaultTableSelectExpression": "Timestamp, ServiceName, SeverityText, Body",
    "timestampValueExpression": "Timestamp",
    "id": "507f1f77bcf86cd799439011",
    "section": "Billing",
    "disabled": false,
    "querySettings": [
      {
        "setting": "max_threads",
        "value": "4"
      }
    ],
    "filterSettings": {
      "databaseName": "default",
      "tableName": "otel_logs",
      "columns": [
        {
          "name": "ServiceName",
          "label": "Service Name",
          "valueExpression": "lower(service_name)",
          "allowAll": false
        }
      ]
    },
    "serviceNameExpression": "ServiceName",
    "serviceVersionExpression": "ResourceAttributes['service.version']",
    "severityTextExpression": "SeverityText",
    "severityNumberExpression": "SeverityNumber",
    "bodyExpression": "Body",
    "eventNameExpression": "EventName",
    "eventAttributesExpression": "LogAttributes",
    "resourceAttributesExpression": "ResourceAttributes",
    "displayedTimestampValueExpression": "TimestampTime",
    "orderByExpression": "Timestamp DESC",
    "metricSourceId": "507f1f77bcf86cd799439013",
    "traceSourceId": "507f1f77bcf86cd799439014",
    "traceIdExpression": "TraceId",
    "spanIdExpression": "SpanId",
    "implicitColumnExpression": "Body",
    "knownColumnsListExpression": "Timestamp, Body, ServiceName",
    "useTextIndexForImplicitColumn": "auto",
    "highlightedTraceAttributeExpressions": [
      {
        "sqlExpression": "SpanAttributes['http.status_code']",
        "luceneExpression": "http.status_code",
        "alias": "HTTP Status Code"
      }
    ],
    "highlightedRowAttributeExpressions": [
      {
        "sqlExpression": "SpanAttributes['http.status_code']",
        "luceneExpression": "http.status_code",
        "alias": "HTTP Status Code"
      }
    ],
    "materializedViews": [
      {
        "databaseName": "otel",
        "tableName": "otel_logs_mv_5m",
        "dimensionColumns": "ServiceName, SeverityText",
        "minGranularity": "5m",
        "timestampColumn": "Timestamp",
        "aggregatedColumns": [
          {
            "aggFn": "sum",
            "mvColumn": "sum__Duration",
            "sourceColumn": "Duration"
          }
        ],
        "minDate": "2025-01-01T00:00:00Z"
      }
    ],
    "metadataMaterializedViews": {
      "keyRollupTable": "otel_logs_key_rollup_15m",
      "kvRollupTable": "otel_logs_kv_rollup_15m",
      "granularity": "15m"
    }
  }
}

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Get started

Services and infrastructure

Bring Your Own Cloud

Data and integrations

Connect and query

Access management

Security and compliance

Monitoring and backups

AI tools and agents

Cloud API

Billing

Support

ClickHouse Private

ClickStack: Create Source

Permission

Authorizations

Path Parameters

Body

Response

​Permission

Authorizations

Path Parameters

Body

Response

Permission