Create FactTable

Create a new fact table. A fact table is a description of a dataset, specifically, it describes which columns correspond to entities, dimensions and measurements. It is the basis for describing metrics.

POST /v1/factTables

Create FactTable

cURL

curl --request POST \
  --url https://metrics.eu.confidence.dev/v1/factTables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "skipSqlPreview": true
}
'

200

{
  "sql": "<string>",
  "displayName": "<string>",
  "timestampColumn": {},
  "entities": [
    {}
  ],
  "state": {},
  "schemaValidationJob": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "description": "<string>",
  "measures": [
    {}
  ],
  "partitionedUpdateStrategyState": {},
  "dimensions": [
    {}
  ],
  "error": {},
  "factDataDeliveredUntilTime": {},
  "dataDeliveredUntilUpdateStrategyConfig": {},
  "deleteTime": {},
  "labels": [
    {}
  ],
  "owner": "<string>",
  "systemCreated": true,
  "skipSqlPreview": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

factTableId · string

The id to the give the created fact table. If a not set a random one will be generated.

Body

application/json

skipSqlPreview · boolean

If set to true, skips the SQL preview query (and goes directly into TABLE_STATE_ACTIVE). When true, all columns must have their types explicitly specified.

Response

200 - application/json

OK

A set of events from some business process, for example, a sale occurred.

sql · string · required

A data warehouse-specific query to get the data of the fact table.

displayName · string · required

Human friendly name of the fact table.

timestampColumn · object · required

The column of the fact table that represents the time the event occurred.

entities · object[] · required

Mapping between columns and the entities involved in the event.

state · object · required

Current state of the fact table.

schemaValidationJob · string · required

Resource name of the sql job that was used to validate the schema of the fact table.

createTime · object · required

Time when the fact table was first created.

updateTime · object · required

Time when the fact table was last updated.

creator · string · required

Reference to the identity that created this fact table.

updater · string · required

Reference to the identity that last updated this fact table.

name · string

Unique identifier of the fact table. For example: factTables/0smva5nxuhv4yts6paxt

description · string

Human readable description of the fact table.

measures · object[]

Mapping between columns of the underlying table and measures.

partitionedUpdateStrategyState · object

dimensions · object[]

Mapping between columns and dimensions of the entities.

error · object

Indicates whether an errors has occurred.

factDataDeliveredUntilTime · object

The current maximum time point where there is available data for the fact table.

dataDeliveredUntilUpdateStrategyConfig · object

The strategy for updating fact_data_delivered_until_time in the fact table.

deleteTime · object

Time when the fact table table was deleted.

labels · object[]

Custom labels for this fact table.

Show child attributes

owner · string

The owner of the resource. If not set will default to the creator.

systemCreated · boolean

If this fact table is an automatically created fact table.

skipSqlPreview · boolean

If set to true, skips the SQL preview query (and goes directly into TABLE_STATE_ACTIVE). When true, all columns must have their types explicitly specified.