PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/warehouse-exports/tablesExportable tables, columns and schema versions
POST/v1/apps/{appId}/warehouse-exports/test-connectionTest the connection without saving
GET/v1/apps/{appId}/warehouse-exportsData warehouse exports
POST/v1/apps/{appId}/warehouse-exportsCreate 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}/testTest the connection of a saved export
POST/v1/apps/{appId}/warehouse-exports/{exportId}/runRun now (from the last successful cursor)
GET/v1/apps/{appId}/warehouse-exports/{exportId}/runsRun history (cursor)

Details

Exportable tables, columns and schema versions

GET/v1/apps/{appId}/warehouse-exports/tablesTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WarehouseTables

FieldTypeRequiredDescription
dataarray<object>Yes
data[].nameenumYesValues: "deliveries", "delivery_events", "events", "conversions", "users", "subscriptions"
data[].modeenumYesValues: "incremental", "snapshot"
data[].schema_versionintegerYes
data[].cursor_columnstring | nullYes
data[].columnsarray<object>Yes
data[].columns[].namestringYes
data[].columns[].typestringYes
data[].columns[].nullablebooleanYes

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

POST/v1/apps/{appId}/warehouse-exports/test-connectionTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"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

FieldTypeRequiredDescription
okbooleanYes
detailstring | nullYes
errorobject | nullYes

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

GET/v1/apps/{appId}/warehouse-exportsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WarehouseExportList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].destinationenumYesValues: "bigquery", "snowflake", "s3_parquet", "redshift", "databricks"
data[].configmap<string, any>Yes
data[].credentials_hintstringYes
data[].tablesarray<enum>Yes
data[].scheduleenumYesValues: "every_15_minutes", "hourly", "daily"
data[].enabledbooleanYes
data[].statusenumYesValues: "active", "paused", "failing"
data[].consecutive_failuresintegerYes
data[].last_errorstring | nullYes
data[].cursorsmap<string, object>Yes
data[].schema_versionsmap<string, integer>Yes
data[].last_run_atstring | nullYes
data[].last_success_atstring | nullYes
data[].next_run_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

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)

POST/v1/apps/{appId}/warehouse-exportsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
destinationenumYesValues: "bigquery", "snowflake", "s3_parquet", "redshift", "databricks"
configmap<string, any>Yes
credentials_hintstringYes
tablesarray<enum>Yes
scheduleenumYesValues: "every_15_minutes", "hourly", "daily"
enabledbooleanYes
statusenumYesValues: "active", "paused", "failing"
consecutive_failuresintegerYes
last_errorstring | nullYes
cursorsmap<string, object>Yes
schema_versionsmap<string, integer>Yes
last_run_atstring | nullYes
last_success_atstring | nullYes
next_run_atstring | nullYes
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/warehouse-exports/{exportId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
exportIdpathstringYes"exp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WarehouseExport

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
destinationenumYesValues: "bigquery", "snowflake", "s3_parquet", "redshift", "databricks"
configmap<string, any>Yes
credentials_hintstringYes
tablesarray<enum>Yes
scheduleenumYesValues: "every_15_minutes", "hourly", "daily"
enabledbooleanYes
statusenumYesValues: "active", "paused", "failing"
consecutive_failuresintegerYes
last_errorstring | nullYes
cursorsmap<string, object>Yes
schema_versionsmap<string, integer>Yes
last_run_atstring | nullYes
last_success_atstring | nullYes
next_run_atstring | nullYes
created_atstringYes
updated_atstringYes

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)

PATCH/v1/apps/{appId}/warehouse-exports/{exportId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
exportIdpathstringYes"exp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateWarehouseExportDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
tablesarray<enum>NoItems: 1–6
scheduleenumNoValues: "every_15_minutes", "hourly", "daily"
enabledbooleanNo
configmap<string, any>No
credentialsmap<string, any>No

Example:

{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "tables": [
    "deliveries"
  ],
  "schedule": "every_15_minutes",
  "config": {
    "key": "örnek"
  }
}

Responses

200 — Success.

Schema: WarehouseExport

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
destinationenumYesValues: "bigquery", "snowflake", "s3_parquet", "redshift", "databricks"
configmap<string, any>Yes
credentials_hintstringYes
tablesarray<enum>Yes
scheduleenumYesValues: "every_15_minutes", "hourly", "daily"
enabledbooleanYes
statusenumYesValues: "active", "paused", "failing"
consecutive_failuresintegerYes
last_errorstring | nullYes
cursorsmap<string, object>Yes
schema_versionsmap<string, integer>Yes
last_run_atstring | nullYes
last_success_atstring | nullYes
next_run_atstring | nullYes
created_atstringYes
updated_atstringYes

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)

DELETE/v1/apps/{appId}/warehouse-exports/{exportId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
exportIdpathstringYes"exp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

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

POST/v1/apps/{appId}/warehouse-exports/{exportId}/testTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
exportIdpathstringYes"exp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WarehouseConnectionResult

FieldTypeRequiredDescription
okbooleanYes
detailstring | nullYes
errorobject | nullYes

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)

POST/v1/apps/{appId}/warehouse-exports/{exportId}/runTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
exportIdpathstringYes"exp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

202 — Success.

Schema: WarehouseExportRun

FieldTypeRequiredDescription
idstringYes
export_idstringYes
triggerenumYesValues: "schedule", "manual"
statusenumYesValues: "queued", "running", "succeeded", "failed"
tablesmap<string, object>Yes
row_countintegerYes
attemptintegerYes
errorstring | nullYes
started_atstring | nullYes
finished_atstring | nullYes
duration_msinteger | nullYes
created_atstringYes

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)

GET/v1/apps/{appId}/warehouse-exports/{exportId}/runsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
exportIdpathstringYes"exp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WarehouseExportRunPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].export_idstringYes
data[].triggerenumYesValues: "schedule", "manual"
data[].statusenumYesValues: "queued", "running", "succeeded", "failed"
data[].tablesmap<string, object>Yes
data[].row_countintegerYes
data[].attemptintegerYes
data[].errorstring | nullYes
data[].started_atstring | nullYes
data[].finished_atstring | nullYes
data[].duration_msinteger | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

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"

On this page