Skip to main content
API docs by Redocly

DataCovey API Schema (13.0.6)

Download OpenAPI specification:Download

Contains tables and functions for managing secure data sharing and querying between organizations while preserving privacy through controlled access and isolation.

PostgREST Documentation

Introspection

OpenAPI description (this document)

Responses

table_history

/table_history

query Parameters
id
string
tenant_id
string
dataset_id
string
name
string
schema
string
created_at
string
changed_at
string
action
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/table_history

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

table_history

id
required
string <uuid>
tenant_id
required
string <uuid>
dataset_id
required
string <uuid>
name
required
string <text>
schema
required
any <jsonb>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "name": "string",
  • "schema": null,
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

/table_history

query Parameters
id
string
tenant_id
string
dataset_id
string
name
string
schema
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/table_history

query Parameters
id
string
tenant_id
string
dataset_id
string
name
string
schema
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

table_history

id
required
string <uuid>
tenant_id
required
string <uuid>
dataset_id
required
string <uuid>
name
required
string <text>
schema
required
any <jsonb>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "name": "string",
  • "schema": null,
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

dataset_history

/dataset_history

query Parameters
id
string
tenant_id
string
project_id
string
name
string
description
string
created_at
string
changed_at
string
action
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/dataset_history

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

dataset_history

id
required
string <uuid>
tenant_id
required
string <uuid>
project_id
required
string <uuid>
name
required
string <text>
description
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "name": "string",
  • "description": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

/dataset_history

query Parameters
id
string
tenant_id
string
project_id
string
name
string
description
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/dataset_history

query Parameters
id
string
tenant_id
string
project_id
string
name
string
description
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

dataset_history

id
required
string <uuid>
tenant_id
required
string <uuid>
project_id
required
string <uuid>
name
required
string <text>
description
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "name": "string",
  • "description": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

export_job_history

/export_job_history

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
changed_at
string
action
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/export_job_history

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

export_job_history

id
required
string <uuid>
tenant_id
required
string <uuid>
table_id
required
string <uuid>
status
required
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

/export_job_history

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/export_job_history

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

export_job_history

id
required
string <uuid>
tenant_id
required
string <uuid>
table_id
required
string <uuid>
status
required
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

table

Data table definition within a dataset

Tables define the structure of data that can be shared and queried, with schema specifications that ensure data consistency and compatibility.

query Parameters
id
string

Unique identifier for the table

tenant_id
string

Reference to the tenant organization that owns the table

dataset_id
string

Reference to the dataset this table belongs to

name
string

Display name of the table

schema
string

JSON schema definition specifying the table structure and constraints

created_at
string

Timestamp when the table was created

archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

Data table definition within a dataset

Tables define the structure of data that can be shared and queried, with schema specifications that ensure data consistency and compatibility.

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

table

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the table

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization that owns the table

Note: This is a Foreign Key to tenant.id.

dataset_id
required
string <uuid>

Reference to the dataset this table belongs to

Note: This is a Foreign Key to dataset.id.

name
required
string <text>

Display name of the table

schema
required
any <jsonb>

JSON schema definition specifying the table structure and constraints

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the table was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "name": "string",
  • "schema": null,
  • "created_at": "now()",
  • "archived_at": "string"
}

Data table definition within a dataset

Tables define the structure of data that can be shared and queried, with schema specifications that ensure data consistency and compatibility.

query Parameters
id
string

Unique identifier for the table

tenant_id
string

Reference to the tenant organization that owns the table

dataset_id
string

Reference to the dataset this table belongs to

name
string

Display name of the table

schema
string

JSON schema definition specifying the table structure and constraints

created_at
string

Timestamp when the table was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Data table definition within a dataset

Tables define the structure of data that can be shared and queried, with schema specifications that ensure data consistency and compatibility.

query Parameters
id
string

Unique identifier for the table

tenant_id
string

Reference to the tenant organization that owns the table

dataset_id
string

Reference to the dataset this table belongs to

name
string

Display name of the table

schema
string

JSON schema definition specifying the table structure and constraints

created_at
string

Timestamp when the table was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

table

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the table

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization that owns the table

Note: This is a Foreign Key to tenant.id.

dataset_id
required
string <uuid>

Reference to the dataset this table belongs to

Note: This is a Foreign Key to dataset.id.

name
required
string <text>

Display name of the table

schema
required
any <jsonb>

JSON schema definition specifying the table structure and constraints

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the table was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "name": "string",
  • "schema": null,
  • "created_at": "now()",
  • "archived_at": "string"
}

import_job_history

/import_job_history

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
changed_at
string
action
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/import_job_history

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

import_job_history

id
required
string <uuid>
tenant_id
required
string <uuid>
table_id
required
string <uuid>
status
required
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

/import_job_history

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/import_job_history

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

import_job_history

id
required
string <uuid>
tenant_id
required
string <uuid>
table_id
required
string <uuid>
status
required
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

query_job

Query execution tracking and statistics

Tracks the execution of queries on BigQuery, including performance metrics, resource usage, and execution status.

query Parameters
id
string

Unique identifier for the query job

tenant_id
string

Reference to the tenant organization that owns the query job

query_id
string

Reference to the query being executed

bigquery_job_id
string

BigQuery job identifier for tracking

status
string

Current status of the query job: PENDING, RUNNING, DONE, or ERROR

error_result
string

Error information if the query failed

error_details
string

Detailed error information and stack traces

created
string

Timestamp when the BigQuery job was created

started
string

Timestamp when the query started executing

ended
string

Timestamp when the query finished executing

total_rows
string

Number of rows processed by the query

total_bytes_processed
string

Amount of data processed in bytes

total_slot_ms
string

Total slot milliseconds used by the query

cache_hit
string

Whether the query results were served from cache

dml_stats
string

Statistics for DML operations

query_plan
string

Execution plan of the query

timeline
string

Timeline of query execution phases

destination_table
string

Target table for query results

num_dml_affected_rows
string

Number of rows affected by DML operations

script_statistics
string

Statistics for script execution

session_info
string

Information about the query session

transaction_info
string

Information about the transaction

reservation_usage
string

Resource reservation usage details

created_at
string

Timestamp when the job record was created

updated_at
string

Timestamp when the job record was last updated

select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

Query execution tracking and statistics

Tracks the execution of queries on BigQuery, including performance metrics, resource usage, and execution status.

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

query_job

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the query job

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization that owns the query job

Note: This is a Foreign Key to tenant.id.

query_id
required
string <uuid>

Reference to the query being executed

Note: This is a Foreign Key to query.id.

bigquery_job_id
required
string <text>

BigQuery job identifier for tracking

status
required
string <text>

Current status of the query job: PENDING, RUNNING, DONE, or ERROR

error_result
any <jsonb>

Error information if the query failed

error_details
any <jsonb>

Detailed error information and stack traces

created
string <timestamp without time zone>

Timestamp when the BigQuery job was created

started
string <timestamp without time zone>

Timestamp when the query started executing

ended
string <timestamp without time zone>

Timestamp when the query finished executing

total_rows
integer <bigint>

Number of rows processed by the query

total_bytes_processed
integer <bigint>

Amount of data processed in bytes

total_slot_ms
integer <bigint>

Total slot milliseconds used by the query

cache_hit
boolean <boolean>

Whether the query results were served from cache

dml_stats
any <jsonb>

Statistics for DML operations

query_plan
any <jsonb>

Execution plan of the query

timeline
any <jsonb>

Timeline of query execution phases

destination_table
any <jsonb>

Target table for query results

num_dml_affected_rows
integer <bigint>

Number of rows affected by DML operations

script_statistics
any <jsonb>

Statistics for script execution

session_info
any <jsonb>

Information about the query session

transaction_info
any <jsonb>

Information about the transaction

reservation_usage
any <jsonb>

Resource reservation usage details

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the job record was created

updated_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the job record was last updated

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "query_id": "6fa29c22-6bab-424a-859e-a13a5c607e72",
  • "bigquery_job_id": "string",
  • "status": "string",
  • "error_result": null,
  • "error_details": null,
  • "created": "string",
  • "started": "string",
  • "ended": "string",
  • "total_rows": 0,
  • "total_bytes_processed": 0,
  • "total_slot_ms": 0,
  • "cache_hit": true,
  • "dml_stats": null,
  • "query_plan": null,
  • "timeline": null,
  • "destination_table": null,
  • "num_dml_affected_rows": 0,
  • "script_statistics": null,
  • "session_info": null,
  • "transaction_info": null,
  • "reservation_usage": null,
  • "created_at": "now()",
  • "updated_at": "now()"
}

Query execution tracking and statistics

Tracks the execution of queries on BigQuery, including performance metrics, resource usage, and execution status.

query Parameters
id
string

Unique identifier for the query job

tenant_id
string

Reference to the tenant organization that owns the query job

query_id
string

Reference to the query being executed

bigquery_job_id
string

BigQuery job identifier for tracking

status
string

Current status of the query job: PENDING, RUNNING, DONE, or ERROR

error_result
string

Error information if the query failed

error_details
string

Detailed error information and stack traces

created
string

Timestamp when the BigQuery job was created

started
string

Timestamp when the query started executing

ended
string

Timestamp when the query finished executing

total_rows
string

Number of rows processed by the query

total_bytes_processed
string

Amount of data processed in bytes

total_slot_ms
string

Total slot milliseconds used by the query

cache_hit
string

Whether the query results were served from cache

dml_stats
string

Statistics for DML operations

query_plan
string

Execution plan of the query

timeline
string

Timeline of query execution phases

destination_table
string

Target table for query results

num_dml_affected_rows
string

Number of rows affected by DML operations

script_statistics
string

Statistics for script execution

session_info
string

Information about the query session

transaction_info
string

Information about the transaction

reservation_usage
string

Resource reservation usage details

created_at
string

Timestamp when the job record was created

updated_at
string

Timestamp when the job record was last updated

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Query execution tracking and statistics

Tracks the execution of queries on BigQuery, including performance metrics, resource usage, and execution status.

query Parameters
id
string

Unique identifier for the query job

tenant_id
string

Reference to the tenant organization that owns the query job

query_id
string

Reference to the query being executed

bigquery_job_id
string

BigQuery job identifier for tracking

status
string

Current status of the query job: PENDING, RUNNING, DONE, or ERROR

error_result
string

Error information if the query failed

error_details
string

Detailed error information and stack traces

created
string

Timestamp when the BigQuery job was created

started
string

Timestamp when the query started executing

ended
string

Timestamp when the query finished executing

total_rows
string

Number of rows processed by the query

total_bytes_processed
string

Amount of data processed in bytes

total_slot_ms
string

Total slot milliseconds used by the query

cache_hit
string

Whether the query results were served from cache

dml_stats
string

Statistics for DML operations

query_plan
string

Execution plan of the query

timeline
string

Timeline of query execution phases

destination_table
string

Target table for query results

num_dml_affected_rows
string

Number of rows affected by DML operations

script_statistics
string

Statistics for script execution

session_info
string

Information about the query session

transaction_info
string

Information about the transaction

reservation_usage
string

Resource reservation usage details

created_at
string

Timestamp when the job record was created

updated_at
string

Timestamp when the job record was last updated

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

query_job

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the query job

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization that owns the query job

Note: This is a Foreign Key to tenant.id.

query_id
required
string <uuid>

Reference to the query being executed

Note: This is a Foreign Key to query.id.

bigquery_job_id
required
string <text>

BigQuery job identifier for tracking

status
required
string <text>

Current status of the query job: PENDING, RUNNING, DONE, or ERROR

error_result
any <jsonb>

Error information if the query failed

error_details
any <jsonb>

Detailed error information and stack traces

created
string <timestamp without time zone>

Timestamp when the BigQuery job was created

started
string <timestamp without time zone>

Timestamp when the query started executing

ended
string <timestamp without time zone>

Timestamp when the query finished executing

total_rows
integer <bigint>

Number of rows processed by the query

total_bytes_processed
integer <bigint>

Amount of data processed in bytes

total_slot_ms
integer <bigint>

Total slot milliseconds used by the query

cache_hit
boolean <boolean>

Whether the query results were served from cache

dml_stats
any <jsonb>

Statistics for DML operations

query_plan
any <jsonb>

Execution plan of the query

timeline
any <jsonb>

Timeline of query execution phases

destination_table
any <jsonb>

Target table for query results

num_dml_affected_rows
integer <bigint>

Number of rows affected by DML operations

script_statistics
any <jsonb>

Statistics for script execution

session_info
any <jsonb>

Information about the query session

transaction_info
any <jsonb>

Information about the transaction

reservation_usage
any <jsonb>

Resource reservation usage details

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the job record was created

updated_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the job record was last updated

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "query_id": "6fa29c22-6bab-424a-859e-a13a5c607e72",
  • "bigquery_job_id": "string",
  • "status": "string",
  • "error_result": null,
  • "error_details": null,
  • "created": "string",
  • "started": "string",
  • "ended": "string",
  • "total_rows": 0,
  • "total_bytes_processed": 0,
  • "total_slot_ms": 0,
  • "cache_hit": true,
  • "dml_stats": null,
  • "query_plan": null,
  • "timeline": null,
  • "destination_table": null,
  • "num_dml_affected_rows": 0,
  • "script_statistics": null,
  • "session_info": null,
  • "transaction_info": null,
  • "reservation_usage": null,
  • "created_at": "now()",
  • "updated_at": "now()"
}

dataset

Collection of related data tables within a project

Datasets organize related tables within a project, enabling structured data sharing and querying between participating organizations.

query Parameters
id
string

Unique identifier for the dataset

tenant_id
string

Reference to the tenant organization that owns the dataset

project_id
string

Reference to the project this dataset belongs to

name
string

Display name of the dataset

description
string

Detailed description of the dataset contents and purpose

created_at
string

Timestamp when the dataset was created

archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

Collection of related data tables within a project

Datasets organize related tables within a project, enabling structured data sharing and querying between participating organizations.

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

dataset

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the dataset

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization that owns the dataset

Note: This is a Foreign Key to tenant.id.

project_id
required
string <uuid>

Reference to the project this dataset belongs to

Note: This is a Foreign Key to project.id.

name
required
string <text>

Display name of the dataset

description
string <text>

Detailed description of the dataset contents and purpose

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the dataset was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "name": "string",
  • "description": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

Collection of related data tables within a project

Datasets organize related tables within a project, enabling structured data sharing and querying between participating organizations.

query Parameters
id
string

Unique identifier for the dataset

tenant_id
string

Reference to the tenant organization that owns the dataset

project_id
string

Reference to the project this dataset belongs to

name
string

Display name of the dataset

description
string

Detailed description of the dataset contents and purpose

created_at
string

Timestamp when the dataset was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Collection of related data tables within a project

Datasets organize related tables within a project, enabling structured data sharing and querying between participating organizations.

query Parameters
id
string

Unique identifier for the dataset

tenant_id
string

Reference to the tenant organization that owns the dataset

project_id
string

Reference to the project this dataset belongs to

name
string

Display name of the dataset

description
string

Detailed description of the dataset contents and purpose

created_at
string

Timestamp when the dataset was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

dataset

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the dataset

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization that owns the dataset

Note: This is a Foreign Key to tenant.id.

project_id
required
string <uuid>

Reference to the project this dataset belongs to

Note: This is a Foreign Key to project.id.

name
required
string <text>

Display name of the dataset

description
string <text>

Detailed description of the dataset contents and purpose

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the dataset was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "name": "string",
  • "description": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

query

Secure data query definitions

Stores queries that perform secure operations on shared data, such as aggregations and set algebra operations, while preserving data privacy.

query Parameters
id
string

Unique identifier for the query

tenant_id
string

Reference to the tenant organization that created the query

project_id
string

Reference to the project this query belongs to

query_text
string

The actual query text to be executed

created_at
string

Timestamp when the query was created

archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

Secure data query definitions

Stores queries that perform secure operations on shared data, such as aggregations and set algebra operations, while preserving data privacy.

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

query

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the query

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization that created the query

Note: This is a Foreign Key to tenant.id.

project_id
required
string <uuid>

Reference to the project this query belongs to

Note: This is a Foreign Key to project.id.

query_text
required
string <text>

The actual query text to be executed

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the query was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "query_text": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

Secure data query definitions

Stores queries that perform secure operations on shared data, such as aggregations and set algebra operations, while preserving data privacy.

query Parameters
id
string

Unique identifier for the query

tenant_id
string

Reference to the tenant organization that created the query

project_id
string

Reference to the project this query belongs to

query_text
string

The actual query text to be executed

created_at
string

Timestamp when the query was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Secure data query definitions

Stores queries that perform secure operations on shared data, such as aggregations and set algebra operations, while preserving data privacy.

query Parameters
id
string

Unique identifier for the query

tenant_id
string

Reference to the tenant organization that created the query

project_id
string

Reference to the project this query belongs to

query_text
string

The actual query text to be executed

created_at
string

Timestamp when the query was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

query

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the query

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization that created the query

Note: This is a Foreign Key to tenant.id.

project_id
required
string <uuid>

Reference to the project this query belongs to

Note: This is a Foreign Key to project.id.

query_text
required
string <text>

The actual query text to be executed

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the query was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "query_text": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

query_history

/query_history

query Parameters
id
string
tenant_id
string
project_id
string
query_text
string
created_at
string
changed_at
string
action
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/query_history

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

query_history

id
required
string <uuid>
tenant_id
required
string <uuid>
project_id
required
string <uuid>
query_text
required
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "query_text": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

/query_history

query Parameters
id
string
tenant_id
string
project_id
string
query_text
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/query_history

query Parameters
id
string
tenant_id
string
project_id
string
query_text
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

query_history

id
required
string <uuid>
tenant_id
required
string <uuid>
project_id
required
string <uuid>
query_text
required
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "query_text": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

project

Collaboration space for data sharing

Projects provide isolated spaces where organizations can define shared dataset schemas and perform secure data operations.

query Parameters
id
string

Unique identifier for the project

tenant_id
string

Reference to the tenant organization that owns the project

name
string

Display name of the project

description
string

Detailed description of the project purpose and scope

created_at
string

Timestamp when the project was created

archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

Collaboration space for data sharing

Projects provide isolated spaces where organizations can define shared dataset schemas and perform secure data operations.

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

project

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the project

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization that owns the project

Note: This is a Foreign Key to tenant.id.

name
required
string <text>

Display name of the project

description
string <text>

Detailed description of the project purpose and scope

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the project was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "name": "string",
  • "description": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

Collaboration space for data sharing

Projects provide isolated spaces where organizations can define shared dataset schemas and perform secure data operations.

query Parameters
id
string

Unique identifier for the project

tenant_id
string

Reference to the tenant organization that owns the project

name
string

Display name of the project

description
string

Detailed description of the project purpose and scope

created_at
string

Timestamp when the project was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Collaboration space for data sharing

Projects provide isolated spaces where organizations can define shared dataset schemas and perform secure data operations.

query Parameters
id
string

Unique identifier for the project

tenant_id
string

Reference to the tenant organization that owns the project

name
string

Display name of the project

description
string

Detailed description of the project purpose and scope

created_at
string

Timestamp when the project was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

project

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the project

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization that owns the project

Note: This is a Foreign Key to tenant.id.

name
required
string <text>

Display name of the project

description
string <text>

Detailed description of the project purpose and scope

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the project was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "name": "string",
  • "description": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

tenant

Organization or company using the DataCovey platform

Represents a distinct organization that participates in secure data sharing and querying. Each tenant's data is strictly isolated from others.

query Parameters
id
string

Unique identifier for the tenant

name
string

Display name of the organization

auth0_org_id
string

Auth0 organization identifier for SSO integration

created_at
string

Timestamp when the tenant was created

archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

Organization or company using the DataCovey platform

Represents a distinct organization that participates in secure data sharing and querying. Each tenant's data is strictly isolated from others.

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

tenant

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the tenant

Note: This is a Primary Key.

name
required
string <text>

Display name of the organization

auth0_org_id
string <text>

Auth0 organization identifier for SSO integration

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the tenant was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "name": "string",
  • "auth0_org_id": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

Organization or company using the DataCovey platform

Represents a distinct organization that participates in secure data sharing and querying. Each tenant's data is strictly isolated from others.

query Parameters
id
string

Unique identifier for the tenant

name
string

Display name of the organization

auth0_org_id
string

Auth0 organization identifier for SSO integration

created_at
string

Timestamp when the tenant was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Organization or company using the DataCovey platform

Represents a distinct organization that participates in secure data sharing and querying. Each tenant's data is strictly isolated from others.

query Parameters
id
string

Unique identifier for the tenant

name
string

Display name of the organization

auth0_org_id
string

Auth0 organization identifier for SSO integration

created_at
string

Timestamp when the tenant was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

tenant

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the tenant

Note: This is a Primary Key.

name
required
string <text>

Display name of the organization

auth0_org_id
string <text>

Auth0 organization identifier for SSO integration

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the tenant was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "name": "string",
  • "auth0_org_id": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

user

Platform user within a tenant organization

Users belong to a tenant organization and have specific roles that determine their access levels and capabilities within the platform.

query Parameters
id
string

Unique identifier for the user

tenant_id
string

Reference to the tenant organization the user belongs to

auth0_id
string

Auth0 user identifier for authentication

email
string

User email address used for communication

name
string

Display name of the user

role
string

User role determining access permissions: Dataset editor, Dataset user, or Org admin

created_at
string

Timestamp when the user was created

archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

Platform user within a tenant organization

Users belong to a tenant organization and have specific roles that determine their access levels and capabilities within the platform.

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

user

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the user

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization the user belongs to

Note: This is a Foreign Key to tenant.id.

auth0_id
required
string <text>

Auth0 user identifier for authentication

email
required
string <text>

User email address used for communication

name
required
string <text>

Display name of the user

role
required
string <text>

User role determining access permissions: Dataset editor, Dataset user, or Org admin

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the user was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "auth0_id": "string",
  • "email": "string",
  • "name": "string",
  • "role": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

Platform user within a tenant organization

Users belong to a tenant organization and have specific roles that determine their access levels and capabilities within the platform.

query Parameters
id
string

Unique identifier for the user

tenant_id
string

Reference to the tenant organization the user belongs to

auth0_id
string

Auth0 user identifier for authentication

email
string

User email address used for communication

name
string

Display name of the user

role
string

User role determining access permissions: Dataset editor, Dataset user, or Org admin

created_at
string

Timestamp when the user was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Platform user within a tenant organization

Users belong to a tenant organization and have specific roles that determine their access levels and capabilities within the platform.

query Parameters
id
string

Unique identifier for the user

tenant_id
string

Reference to the tenant organization the user belongs to

auth0_id
string

Auth0 user identifier for authentication

email
string

User email address used for communication

name
string

Display name of the user

role
string

User role determining access permissions: Dataset editor, Dataset user, or Org admin

created_at
string

Timestamp when the user was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

user

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the user

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization the user belongs to

Note: This is a Foreign Key to tenant.id.

auth0_id
required
string <text>

Auth0 user identifier for authentication

email
required
string <text>

User email address used for communication

name
required
string <text>

Display name of the user

role
required
string <text>

User role determining access permissions: Dataset editor, Dataset user, or Org admin

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the user was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "auth0_id": "string",
  • "email": "string",
  • "name": "string",
  • "role": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

import_job

Data import operation tracking

Tracks the status and progress of data import operations into tables, ensuring data integrity and visibility of import processes.

query Parameters
id
string

Unique identifier for the import job

tenant_id
string

Reference to the tenant organization performing the import

table_id
string

Reference to the table being imported into

status
string

Current status of the import job: pending, running, completed, or failed

created_at
string

Timestamp when the import job was created

archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

Data import operation tracking

Tracks the status and progress of data import operations into tables, ensuring data integrity and visibility of import processes.

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

import_job

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the import job

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization performing the import

Note: This is a Foreign Key to tenant.id.

table_id
required
string <uuid>

Reference to the table being imported into

Note: This is a Foreign Key to table.id.

status
required
string <text>

Current status of the import job: pending, running, completed, or failed

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the import job was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

Data import operation tracking

Tracks the status and progress of data import operations into tables, ensuring data integrity and visibility of import processes.

query Parameters
id
string

Unique identifier for the import job

tenant_id
string

Reference to the tenant organization performing the import

table_id
string

Reference to the table being imported into

status
string

Current status of the import job: pending, running, completed, or failed

created_at
string

Timestamp when the import job was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Data import operation tracking

Tracks the status and progress of data import operations into tables, ensuring data integrity and visibility of import processes.

query Parameters
id
string

Unique identifier for the import job

tenant_id
string

Reference to the tenant organization performing the import

table_id
string

Reference to the table being imported into

status
string

Current status of the import job: pending, running, completed, or failed

created_at
string

Timestamp when the import job was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

import_job

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the import job

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization performing the import

Note: This is a Foreign Key to tenant.id.

table_id
required
string <uuid>

Reference to the table being imported into

Note: This is a Foreign Key to table.id.

status
required
string <text>

Current status of the import job: pending, running, completed, or failed

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the import job was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

export_job

Data export operation tracking

Tracks the status and progress of data export operations from tables, ensuring secure and controlled data extraction.

query Parameters
id
string

Unique identifier for the export job

tenant_id
string

Reference to the tenant organization performing the export

table_id
string

Reference to the table being exported from

status
string

Current status of the export job: pending, running, completed, or failed

created_at
string

Timestamp when the export job was created

archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

Data export operation tracking

Tracks the status and progress of data export operations from tables, ensuring secure and controlled data extraction.

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

export_job

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the export job

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization performing the export

Note: This is a Foreign Key to tenant.id.

table_id
required
string <uuid>

Reference to the table being exported from

Note: This is a Foreign Key to table.id.

status
required
string <text>

Current status of the export job: pending, running, completed, or failed

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the export job was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

Data export operation tracking

Tracks the status and progress of data export operations from tables, ensuring secure and controlled data extraction.

query Parameters
id
string

Unique identifier for the export job

tenant_id
string

Reference to the tenant organization performing the export

table_id
string

Reference to the table being exported from

status
string

Current status of the export job: pending, running, completed, or failed

created_at
string

Timestamp when the export job was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

Data export operation tracking

Tracks the status and progress of data export operations from tables, ensuring secure and controlled data extraction.

query Parameters
id
string

Unique identifier for the export job

tenant_id
string

Reference to the tenant organization performing the export

table_id
string

Reference to the table being exported from

status
string

Current status of the export job: pending, running, completed, or failed

created_at
string

Timestamp when the export job was created

archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

export_job

id
required
string <uuid>
Default: "gen_random_uuid()"

Unique identifier for the export job

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Reference to the tenant organization performing the export

Note: This is a Foreign Key to tenant.id.

table_id
required
string <uuid>

Reference to the table being exported from

Note: This is a Foreign Key to table.id.

status
required
string <text>

Current status of the export job: pending, running, completed, or failed

created_at
string <timestamp without time zone>
Default: "now()"

Timestamp when the export job was created

archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}