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.
CSV export jobs (users, subscriptions, events, deliveries) and imports (Pushizo CSV, legacy provider player CSV; multipart).
Base URL: https://api.pushizo.com · Tag: exports · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/exports | Export jobs |
POST | /v1/apps/{appId}/exports | Start an export job |
GET | /v1/apps/{appId}/exports/{exportId} | Export status (download_url) |
GET | /v1/apps/{appId}/imports | Import jobs |
POST | /v1/apps/{appId}/imports | Start an import job (multipart: type, file) |
GET | /v1/apps/{appId}/imports/{importId} | Import status |
Details
Export jobs
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
limit | query | integer | No | Default: 50; Range: 1–100 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ExportList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].type | enum | Yes | Values: "users", "subscriptions", "events", "deliveries", "message_events" |
data[].filters | object | Yes | |
data[].filters.from | string (date-time) | No | |
data[].filters.to | string (date-time) | No | |
data[].filters.name | string | No | Length: 0–100 |
data[].filters.message_id | string | No | Length: 0–64 |
data[].filters.campaign_id | string | No | Length: 0–64 |
data[].filters.status | string | No | Length: 0–32 |
data[].filters.channel | enum | No | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
data[].filters.segment_id | string | No | Length: 0–64 |
data[].status | enum | Yes | Values: "pending", "running", "completed", "failed" |
data[].row_count | integer | null | Yes | |
data[].error | string | null | Yes | |
data[].download_url | string | null | Yes | |
data[].expires_at | string | null | Yes | |
data[].requested_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].completed_at | string | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"type": "users",
"status": "pending",
"id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"filters": {
"name": "Sipariş bildirimleri",
"channel": "ios_push"
},
"row_count": 1,
"error": "örnek",
"download_url": "https://pushizo.com/orders/1001",
"expires_at": "örnek",
"requested_by": "örnek",
"created_at": "örnek",
"completed_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/exports?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Start an export job
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: CreateExportDto
| Field | Type | Required | Description |
|---|---|---|---|
type | enum | Yes | Values: "users", "subscriptions", "events", "deliveries", "message_events" |
filters | object | No | Default: {} |
filters.from | string (date-time) | No | |
filters.to | string (date-time) | No | |
filters.name | string | No | Length: 0–100 |
filters.message_id | string | No | Length: 0–64 |
filters.campaign_id | string | No | Length: 0–64 |
filters.status | string | No | Length: 0–32 |
filters.channel | enum | No | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
filters.segment_id | string | No | Length: 0–64 |
Example:
{
"type": "users",
"filters": {}
}Responses
200 — Success.
Schema: Export
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
type | enum | Yes | Values: "users", "subscriptions", "events", "deliveries", "message_events" |
filters | object | Yes | |
filters.from | string (date-time) | No | |
filters.to | string (date-time) | No | |
filters.name | string | No | Length: 0–100 |
filters.message_id | string | No | Length: 0–64 |
filters.campaign_id | string | No | Length: 0–64 |
filters.status | string | No | Length: 0–32 |
filters.channel | enum | No | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
filters.segment_id | string | No | Length: 0–64 |
status | enum | Yes | Values: "pending", "running", "completed", "failed" |
row_count | integer | null | Yes | |
error | string | null | Yes | |
download_url | string | null | Yes | |
expires_at | string | null | Yes | |
requested_by | string | null | Yes | |
created_at | string | Yes | |
completed_at | string | null | Yes |
Example response:
{
"type": "users",
"status": "pending",
"id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"filters": {
"name": "Sipariş bildirimleri",
"channel": "ios_push",
"status": "örnek",
"from": "2026-10-17T09:00:00Z"
},
"row_count": 1,
"error": "örnek",
"download_url": "https://pushizo.com/orders/1001",
"expires_at": "örnek",
"requested_by": "örnek",
"created_at": "örnek",
"completed_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/exports" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "users",
"filters": {}
}'Export status (download_url)
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: Export
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
type | enum | Yes | Values: "users", "subscriptions", "events", "deliveries", "message_events" |
filters | object | Yes | |
filters.from | string (date-time) | No | |
filters.to | string (date-time) | No | |
filters.name | string | No | Length: 0–100 |
filters.message_id | string | No | Length: 0–64 |
filters.campaign_id | string | No | Length: 0–64 |
filters.status | string | No | Length: 0–32 |
filters.channel | enum | No | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
filters.segment_id | string | No | Length: 0–64 |
status | enum | Yes | Values: "pending", "running", "completed", "failed" |
row_count | integer | null | Yes | |
error | string | null | Yes | |
download_url | string | null | Yes | |
expires_at | string | null | Yes | |
requested_by | string | null | Yes | |
created_at | string | Yes | |
completed_at | string | null | Yes |
Example response:
{
"type": "users",
"status": "pending",
"id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"filters": {
"name": "Sipariş bildirimleri",
"channel": "ios_push",
"status": "örnek",
"from": "2026-10-17T09:00:00Z"
},
"row_count": 1,
"error": "örnek",
"download_url": "https://pushizo.com/orders/1001",
"expires_at": "örnek",
"requested_by": "örnek",
"created_at": "örnek",
"completed_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/exports/exp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Import jobs
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
limit | query | integer | No | Default: 50; Range: 1–100 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ImportList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].type | enum | Yes | Values: "legacy_players", "csv_users" |
data[].file_name | string | null | Yes | |
data[].status | enum | Yes | Values: "pending", "running", "completed", "failed" |
data[].stats | object | Yes | |
data[].stats.processed | integer | No | |
data[].stats.created_users | integer | No | |
data[].stats.updated_users | integer | No | |
data[].stats.created_subscriptions | integer | No | |
data[].stats.skipped | integer | No | |
data[].stats.errors | integer | No | |
data[].stats.rejected_emails | integer | No | |
data[].stats.rejected_email_reasons | map<string, integer> | No | |
data[].error | string | null | Yes | |
data[].error_report_url | string | null | Yes | |
data[].requested_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].completed_at | string | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"type": "legacy_players",
"status": "pending",
"id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"file_name": "örnek",
"stats": {
"processed": 1,
"created_users": 1
},
"error": "örnek",
"error_report_url": "https://pushizo.com/orders/1001",
"requested_by": "örnek",
"created_at": "örnek",
"completed_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/imports?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Start an import job (multipart: type, file)
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)
Content type: multipart/form-data.
| Field | Type | Required | Description |
|---|---|---|---|
type | enum | Yes | Values: "legacy_players", "csv_users" |
file | string (binary) | Yes | CSV file (UTF-8, up to 50 MB) |
Example:
{
"type": "legacy_players",
"file": "örnek"
}Responses
200 — Success.
Schema: Import
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
type | enum | Yes | Values: "legacy_players", "csv_users" |
file_name | string | null | Yes | |
status | enum | Yes | Values: "pending", "running", "completed", "failed" |
stats | object | Yes | |
stats.processed | integer | No | |
stats.created_users | integer | No | |
stats.updated_users | integer | No | |
stats.created_subscriptions | integer | No | |
stats.skipped | integer | No | |
stats.errors | integer | No | |
stats.rejected_emails | integer | No | |
stats.rejected_email_reasons | map<string, integer> | No | |
error | string | null | Yes | |
error_report_url | string | null | Yes | |
requested_by | string | null | Yes | |
created_at | string | Yes | |
completed_at | string | null | Yes |
Example response:
{
"type": "legacy_players",
"status": "pending",
"id": "imp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"file_name": "örnek",
"stats": {
"processed": 1,
"created_users": 1,
"updated_users": 1,
"created_subscriptions": 1
},
"error": "örnek",
"error_report_url": "https://pushizo.com/orders/1001",
"requested_by": "örnek",
"created_at": "örnek",
"completed_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/imports" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-F "type=legacy_players" \
-F "file=@users.csv"Import status
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
importId | path | string | Yes | "imp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Import
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
type | enum | Yes | Values: "legacy_players", "csv_users" |
file_name | string | null | Yes | |
status | enum | Yes | Values: "pending", "running", "completed", "failed" |
stats | object | Yes | |
stats.processed | integer | No | |
stats.created_users | integer | No | |
stats.updated_users | integer | No | |
stats.created_subscriptions | integer | No | |
stats.skipped | integer | No | |
stats.errors | integer | No | |
stats.rejected_emails | integer | No | |
stats.rejected_email_reasons | map<string, integer> | No | |
error | string | null | Yes | |
error_report_url | string | null | Yes | |
requested_by | string | null | Yes | |
created_at | string | Yes | |
completed_at | string | null | Yes |
Example response:
{
"type": "legacy_players",
"status": "pending",
"id": "imp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"file_name": "örnek",
"stats": {
"processed": 1,
"created_users": 1,
"updated_users": 1,
"created_subscriptions": 1
},
"error": "örnek",
"error_report_url": "https://pushizo.com/orders/1001",
"requested_by": "örnek",
"created_at": "örnek",
"completed_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/imports/imp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Analytics
Analytics — 54 operations (GET /v1/apps/{appId}/rfm/config, PUT /v1/apps/{appId}/rfm/config, POST /v1/apps/{appId}/rfm/compute, …). Generated from the OpenAPI 3.1.0 contract.
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.