Data warehouse export
Data warehouse export — 10 operations (GET /v1/apps/{appId}/warehouse-exports/tables, POST /v1/apps/{appId}/warehouse-exports/test-connection, GET /v1/apps/{appId}/warehouse-exports, …). Generated from the OpenAPI 3.1.0 contract.
Data warehouse (BigQuery, Snowflake, S3/Parquet) export jobs: definition, connection test, runs and history.
Base URL: https://api.pushizo.com · Tag: warehouse · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/warehouse-exports/tables | Exportable tables, columns and schema versions |
POST | /v1/apps/{appId}/warehouse-exports/test-connection | Test the connection without saving |
GET | /v1/apps/{appId}/warehouse-exports | Data warehouse exports |
POST | /v1/apps/{appId}/warehouse-exports | Create an export (credentials are stored encrypted and not returned in the response) |
GET | /v1/apps/{appId}/warehouse-exports/{exportId} | Export details |
PATCH | /v1/apps/{appId}/warehouse-exports/{exportId} | Update an export (name, tables, schedule, enabled/paused, destination settings, credentials) |
DELETE | /v1/apps/{appId}/warehouse-exports/{exportId} | Delete an export (data at the destination is not deleted) |
POST | /v1/apps/{appId}/warehouse-exports/{exportId}/test | Test the connection of a saved export |
POST | /v1/apps/{appId}/warehouse-exports/{exportId}/run | Run now (from the last successful cursor) |
GET | /v1/apps/{appId}/warehouse-exports/{exportId}/runs | Run history (cursor) |
Details
Exportable tables, columns and schema versions
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WarehouseTables
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].name | enum | Yes | Values: "deliveries", "delivery_events", "events", "conversions", "users", "subscriptions" |
data[].mode | enum | Yes | Values: "incremental", "snapshot" |
data[].schema_version | integer | Yes | |
data[].cursor_column | string | null | Yes | |
data[].columns | array<object> | Yes | |
data[].columns[].name | string | Yes | |
data[].columns[].type | string | Yes | |
data[].columns[].nullable | boolean | Yes |
Example response:
{
"data": [
{
"name": "deliveries",
"mode": "incremental",
"schema_version": 1,
"cursor_column": "örnek",
"columns": [
{
"name": "Sipariş bildirimleri",
"type": "örnek",
"nullable": true
}
]
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/warehouse-exports/tables" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Test the connection without saving
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: WarehouseConnectionTest
Type: WarehouseConnectionTest
Example:
{
"destination": "bigquery",
"config": {
"project_id": "cac_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"dataset": "değer",
"location": "değer",
"table_prefix": "değer"
},
"credentials": {
"service_account_json": "örnek"
}
}Responses
200 — Success.
Schema: WarehouseConnectionResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | |
detail | string | null | Yes | |
error | object | null | Yes |
Example response:
{
"ok": true,
"detail": "örnek",
"error": {
"code": "örnek",
"message": "Takip bağlantısı içeride"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/warehouse-exports/test-connection" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"destination": "bigquery",
"config": {
"project_id": "cac_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"dataset": "değer",
"location": "değer",
"table_prefix": "değer"
},
"credentials": {
"service_account_json": "örnek"
}
}'Data warehouse exports
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WarehouseExportList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].destination | enum | Yes | Values: "bigquery", "snowflake", "s3_parquet", "redshift", "databricks" |
data[].config | map<string, any> | Yes | |
data[].credentials_hint | string | Yes | |
data[].tables | array<enum> | Yes | |
data[].schedule | enum | Yes | Values: "every_15_minutes", "hourly", "daily" |
data[].enabled | boolean | Yes | |
data[].status | enum | Yes | Values: "active", "paused", "failing" |
data[].consecutive_failures | integer | Yes | |
data[].last_error | string | null | Yes | |
data[].cursors | map<string, object> | Yes | |
data[].schema_versions | map<string, integer> | Yes | |
data[].last_run_at | string | null | Yes | |
data[].last_success_at | string | null | Yes | |
data[].next_run_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"enabled": true,
"status": "active",
"id": "wex_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"destination": "bigquery",
"config": {
"key": "örnek"
},
"credentials_hint": "örnek",
"tables": [
"deliveries"
],
"schedule": "every_15_minutes",
"consecutive_failures": 1,
"last_error": "örnek",
"cursors": {
"key": {
"ts": "örnek",
"id": "wex_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
},
"schema_versions": {
"key": 150
},
"last_run_at": "örnek",
"last_success_at": "örnek",
"next_run_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/warehouse-exports" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create an export (credentials are stored encrypted and not returned in the response)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: WarehouseExportCreate
Type: WarehouseExportCreate
Example:
{
"name": "Sipariş bildirimleri",
"tables": [
"deliveries"
],
"schedule": "every_15_minutes",
"destination": "bigquery",
"config": {
"project_id": "cac_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"dataset": "değer",
"location": "değer",
"table_prefix": "değer"
},
"credentials": {
"service_account_json": "örnek"
},
"enabled": true
}Responses
201 — Success.
Schema: WarehouseExport
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
destination | enum | Yes | Values: "bigquery", "snowflake", "s3_parquet", "redshift", "databricks" |
config | map<string, any> | Yes | |
credentials_hint | string | Yes | |
tables | array<enum> | Yes | |
schedule | enum | Yes | Values: "every_15_minutes", "hourly", "daily" |
enabled | boolean | Yes | |
status | enum | Yes | Values: "active", "paused", "failing" |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
cursors | map<string, object> | Yes | |
schema_versions | map<string, integer> | Yes | |
last_run_at | string | null | Yes | |
last_success_at | string | null | Yes | |
next_run_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"status": "active",
"id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"destination": "bigquery",
"config": {
"key": "örnek"
},
"credentials_hint": "örnek",
"tables": [
"deliveries"
],
"schedule": "every_15_minutes",
"consecutive_failures": 1,
"last_error": "örnek",
"cursors": {
"key": {
"ts": "örnek",
"id": "wex_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
},
"schema_versions": {
"key": 150
},
"last_run_at": "örnek",
"last_success_at": "örnek",
"next_run_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/warehouse-exports" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"tables": [
"deliveries"
],
"schedule": "every_15_minutes",
"destination": "bigquery",
"config": {
"project_id": "cac_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"dataset": "değer",
"location": "değer",
"table_prefix": "değer"
},
"credentials": {
"service_account_json": "örnek"
},
"enabled": true
}'Export details
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
exportId | path | string | Yes | "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WarehouseExport
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
destination | enum | Yes | Values: "bigquery", "snowflake", "s3_parquet", "redshift", "databricks" |
config | map<string, any> | Yes | |
credentials_hint | string | Yes | |
tables | array<enum> | Yes | |
schedule | enum | Yes | Values: "every_15_minutes", "hourly", "daily" |
enabled | boolean | Yes | |
status | enum | Yes | Values: "active", "paused", "failing" |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
cursors | map<string, object> | Yes | |
schema_versions | map<string, integer> | Yes | |
last_run_at | string | null | Yes | |
last_success_at | string | null | Yes | |
next_run_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"status": "active",
"id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"destination": "bigquery",
"config": {
"key": "örnek"
},
"credentials_hint": "örnek",
"tables": [
"deliveries"
],
"schedule": "every_15_minutes",
"consecutive_failures": 1,
"last_error": "örnek",
"cursors": {
"key": {
"ts": "örnek",
"id": "wex_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
},
"schema_versions": {
"key": 150
},
"last_run_at": "örnek",
"last_success_at": "örnek",
"next_run_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/warehouse-exports/exp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update an export (name, tables, schedule, enabled/paused, destination settings, credentials)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
exportId | path | string | Yes | "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateWarehouseExportDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
tables | array<enum> | No | Items: 1–6 |
schedule | enum | No | Values: "every_15_minutes", "hourly", "daily" |
enabled | boolean | No | |
config | map<string, any> | No | |
credentials | map<string, any> | No |
Example:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"tables": [
"deliveries"
],
"schedule": "every_15_minutes",
"config": {
"key": "örnek"
}
}Responses
200 — Success.
Schema: WarehouseExport
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
destination | enum | Yes | Values: "bigquery", "snowflake", "s3_parquet", "redshift", "databricks" |
config | map<string, any> | Yes | |
credentials_hint | string | Yes | |
tables | array<enum> | Yes | |
schedule | enum | Yes | Values: "every_15_minutes", "hourly", "daily" |
enabled | boolean | Yes | |
status | enum | Yes | Values: "active", "paused", "failing" |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
cursors | map<string, object> | Yes | |
schema_versions | map<string, integer> | Yes | |
last_run_at | string | null | Yes | |
last_success_at | string | null | Yes | |
next_run_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"status": "active",
"id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"destination": "bigquery",
"config": {
"key": "örnek"
},
"credentials_hint": "örnek",
"tables": [
"deliveries"
],
"schedule": "every_15_minutes",
"consecutive_failures": 1,
"last_error": "örnek",
"cursors": {
"key": {
"ts": "örnek",
"id": "wex_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
},
"schema_versions": {
"key": 150
},
"last_run_at": "örnek",
"last_success_at": "örnek",
"next_run_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/warehouse-exports/exp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"enabled": true,
"tables": [
"deliveries"
],
"schedule": "every_15_minutes",
"config": {
"key": "örnek"
}
}'Delete an export (data at the destination is not deleted)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
exportId | path | string | Yes | "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Example response:
{
"ok": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/warehouse-exports/exp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Test the connection of a saved export
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
exportId | path | string | Yes | "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WarehouseConnectionResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | |
detail | string | null | Yes | |
error | object | null | Yes |
Example response:
{
"ok": true,
"detail": "örnek",
"error": {
"code": "örnek",
"message": "Takip bağlantısı içeride"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/warehouse-exports/exp_01JD3W5Q7X9K2M4N6P8R0T1V3W/test" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Run now (from the last successful cursor)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
exportId | path | string | Yes | "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
202 — Success.
Schema: WarehouseExportRun
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
export_id | string | Yes | |
trigger | enum | Yes | Values: "schedule", "manual" |
status | enum | Yes | Values: "queued", "running", "succeeded", "failed" |
tables | map<string, object> | Yes | |
row_count | integer | Yes | |
attempt | integer | Yes | |
error | string | null | Yes | |
started_at | string | null | Yes | |
finished_at | string | null | Yes | |
duration_ms | integer | null | Yes | |
created_at | string | Yes |
Example response:
{
"status": "queued",
"id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"export_id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"trigger": "schedule",
"tables": {
"key": {
"rows": 1,
"schema_version": 1,
"from": {
"ts": "örnek",
"id": "wex_01JD3W5Q7X9K2M4N6P8R0T1V3W"
},
"to": {
"ts": "örnek",
"id": "wex_01JD3W5Q7X9K2M4N6P8R0T1V3W"
},
"objects": 1
}
},
"row_count": 1,
"attempt": 1,
"error": "örnek",
"started_at": "örnek",
"finished_at": "örnek",
"duration_ms": 1,
"created_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/warehouse-exports/exp_01JD3W5Q7X9K2M4N6P8R0T1V3W/run" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Run history (cursor)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
exportId | path | string | Yes | "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WarehouseExportRunPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].export_id | string | Yes | |
data[].trigger | enum | Yes | Values: "schedule", "manual" |
data[].status | enum | Yes | Values: "queued", "running", "succeeded", "failed" |
data[].tables | map<string, object> | Yes | |
data[].row_count | integer | Yes | |
data[].attempt | integer | Yes | |
data[].error | string | null | Yes | |
data[].started_at | string | null | Yes | |
data[].finished_at | string | null | Yes | |
data[].duration_ms | integer | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"status": "queued",
"id": "wex_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"export_id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"trigger": "schedule",
"tables": {
"key": {
"rows": 1,
"schema_version": 1,
"from": {},
"to": {},
"objects": 1
}
},
"row_count": 1,
"attempt": 1,
"error": "örnek",
"started_at": "örnek",
"finished_at": "örnek",
"duration_ms": 1,
"created_at": "örnek"
}
],
"next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
"has_more": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/warehouse-exports/exp_01JD3W5Q7X9K2M4N6P8R0T1V3W/runs?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Export / import
Export / import — 6 operations (GET /v1/apps/{appId}/exports, POST /v1/apps/{appId}/exports, GET /v1/apps/{appId}/exports/{exportId}, …). Generated from the OpenAPI 3.1.0 contract.
Integrations
Integrations — 26 operations (GET /v1/apps/{appId}/data-pipelines/transforms, POST /v1/apps/{appId}/data-pipelines/transforms, POST /v1/apps/{appId}/data-pipelines/transforms/preview, …). Generated from the OpenAPI 3.1.0 contract.