Tables

Add custom metrics

Add custom metrics. For columns, add columnName.

put/v1/tables/{id}/customMetric

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/tables/{id}/customMetric
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Id of the table

Request body

descriptionstring
namestring required
columnNamestring
expressionstring required
updatedAtinteger
updatedBystring

Response

OK

idstring uuid required
namestring required
displayNamestring
fullyQualifiedNamestring
descriptionstring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
hrefstring uri
tableType'Regular' | 'External' | 'Dynamic' | 'View' | 'SecureView' | 'MaterializedView' | 'Iceberg' | 'Local' | 'Partitioned' | 'Foreign' | 'Transient' | 'Stream' | 'Stage' | 'SemanticView'
aliasesstring[]
serviceType'BigQuery' | 'BigTable' | 'Mysql' | 'Redshift' | 'Snowflake' | 'Postgres' | 'Timescale' | 'Mssql' | 'MicrosoftAccess' | 'Oracle' | 'Athena' | 'Hive' | 'Impala' | 'Presto' | 'Trino' | 'Vertica' | 'Glue' | 'MariaDB' | 'Druid' | 'Db2' | 'Clickhouse' | 'Databricks' | 'AzureSQL' | 'DynamoDB' | 'SingleStore' | 'SQLite' | 'DeltaLake' | 'Salesforce' | 'PinotDB' | 'Datalake' | 'DomoDatabase' | 'QueryLog' | 'CustomDatabase' | 'Dbt' | 'SapHana' | 'SapSuccessFactors' | 'MongoDB' | 'Cassandra' | 'Couchbase' | 'Greenplum' | 'Doris' | 'StarRocks' | 'UnityCatalog' | 'SAS' | 'Teradata' | 'SapErp' | 'Synapse' | 'Exasol' | 'Cockroach' | 'SSAS' | 'Epic' | 'ServiceNow' | 'Dremio' | 'MicrosoftFabric' | 'BurstIQ' | 'Informix' | 'Iomete' | 'QuestDB' | 'SapBw4Hana'
locationPathstring
schemaDefinitionstring
deletedboolean
retentionPeriodstring
compressionEnabledboolean
compressionCodecstring
extensionobject
sourceUrlstring
fileFormat'csv' | 'csv.gz' | 'tsv' | 'avro' | 'parquet' | 'pq' | 'pqt' | 'parq' | 'parquet.snappy' | 'json' | 'json.gz' | 'json.zip' | 'jsonl' | 'jsonl.gz' | 'jsonl.zip' | 'MF4'
sourceHashstring
processedLineageboolean
queriesstring[]
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'

Changes

No recorded changes to this operation across all 1 revision of this API.