Ads (audiences, campaigns, attribution)
Ads (audiences, campaigns, attribution) — 33 operations (GET /v1/apps/{appId}/ads/platforms, GET /v1/apps/{appId}/ads/accounts, GET /v1/apps/{appId}/ads/audiences, …). Generated from the OpenAPI 3.1.0 contract.
Meta, Google Ads, TikTok and LinkedIn ad accounts: ad audience sync from segments (only users with ad personalization consent, hashed with SHA-256), lookalikes, campaign/ad set lists, status and daily budget, spend, attribution and LTV reports, Conversions API and budget alerts. Accounts are connected (OAuth) from the dashboard.
Base URL: https://api.pushizo.com · Tag: ads · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/ads/platforms | Ad platforms (enabled/mock, identifiers, lookalike support) |
GET | /v1/apps/{appId}/ads/accounts | Connected ad accounts |
GET | /v1/apps/{appId}/ads/audiences | Ad audiences |
POST | /v1/apps/{appId}/ads/audiences | Create an ad audience |
GET | /v1/apps/{appId}/ads/audiences/{audienceId} | Ad audience details |
PATCH | /v1/apps/{appId}/ads/audiences/{audienceId} | Update an ad audience |
DELETE | /v1/apps/{appId}/ads/audiences/{audienceId} | Delete an ad audience |
POST | /v1/apps/{appId}/ads/audiences/{audienceId}/sync | Run the sync now |
GET | /v1/apps/{appId}/ads/audiences/{audienceId}/syncs | Sync history |
POST | /v1/apps/{appId}/ads/audiences/{audienceId}/lookalikes | Create a lookalike audience |
GET | /v1/apps/{appId}/ads/campaigns | Campaign / ad set / ad list and metrics |
POST | /v1/apps/{appId}/ads/campaigns | Create an ad campaign: campaign + ad set (Pushizo audience) + creative/ad |
GET | /v1/apps/{appId}/ads/campaigns/{entityId} | Campaign / ad set / ad details |
PATCH | /v1/apps/{appId}/ads/campaigns/{entityId} | Change status and daily budget |
GET | /v1/apps/{appId}/ads/campaigns/{entityId}/preview | Creative preview (platform preview link + creative summary) |
GET | /v1/apps/{appId}/ads/accounts/{accountId}/pages | Meta: Facebook pages the account can promote |
GET | /v1/apps/{appId}/ads/creatives | Uploaded creative images |
POST | /v1/apps/{appId}/ads/creatives | Upload a creative image (multipart file: PNG/JPEG, up to 5 MB) |
GET | /v1/apps/{appId}/ads/settings | Reporting currency (organization) and attribution defaults (app) |
PUT | /v1/apps/{appId}/ads/settings | Update the reporting currency and attribution defaults |
POST | /v1/apps/{appId}/ads/conversions-api/configs/{configId}/test | Send a synthetic test event to the platform's test tool |
POST | /v1/apps/{appId}/ads/conversions-api/deliveries/{deliveryId}/retry | Retry a failed delivery |
POST | /v1/apps/{appId}/ads/accounts/{accountId}/refresh | Refresh campaigns and metrics now |
GET | /v1/apps/{appId}/ads/reports/spend | Spend and performance report |
GET | /v1/apps/{appId}/ads/reports/attribution | Unified attribution report (ROAS, CAC) |
GET | /v1/apps/{appId}/ads/reports/ltv | Cohort LTV report |
GET | /v1/apps/{appId}/ads/conversions-api/configs | Conversions API configurations |
GET | /v1/apps/{appId}/ads/conversions-api/deliveries | Conversions API delivery history |
GET | /v1/apps/{appId}/ads/alert-rules | Budget alert rules |
POST | /v1/apps/{appId}/ads/alert-rules | Create a budget alert rule |
PATCH | /v1/apps/{appId}/ads/alert-rules/{ruleId} | Update a budget alert rule |
DELETE | /v1/apps/{appId}/ads/alert-rules/{ruleId} | Delete a budget alert rule |
GET | /v1/apps/{appId}/ads/alerts | Triggered budget alerts |
Details
Ad platforms (enabled/mock, identifiers, lookalike support)
Authentication: API key — scope segments:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdPlatformList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].platform | enum | Yes | Values: "meta", "google", "tiktok", "linkedin" |
data[].enabled | boolean | Yes | |
data[].mock | boolean | Yes | |
data[].identifiers | array<enum> | Yes | |
data[].lookalike | boolean | Yes | |
data[].batch_size | integer | Yes |
Example response:
{
"data": [
{
"enabled": true,
"platform": "meta",
"mock": true,
"identifiers": [
"email"
],
"lookalike": true,
"batch_size": 1
}
]
}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/ads/platforms" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Connected ad accounts
Authentication: API key — scope segments:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdAccountList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].platform | enum | Yes | Values: "meta", "google", "tiktok", "linkedin" |
data[].external_id | string | Yes | |
data[].name | string | Yes | |
data[].currency | string | null | Yes | |
data[].timezone | string | null | Yes | |
data[].status | enum | Yes | Values: "active", "error", "revoked" |
data[].scopes | array<string> | Yes | |
data[].login_customer_id | string | null | Yes | |
data[].token_expires_at | string | null | Yes | |
data[].last_refreshed_at | string | null | Yes | |
data[].last_error | string | null | Yes | |
data[].last_error_at | string | null | Yes | |
data[].terms_accepted_at | string | null | Yes | |
data[].terms_version | string | null | Yes | |
data[].audiences | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform": "meta",
"external_id": "user_42",
"currency": "TRY",
"timezone": "Europe/Istanbul",
"scopes": [
"notifications:write"
],
"login_customer_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_expires_at": "örnek",
"last_refreshed_at": "örnek",
"last_error": "örnek",
"last_error_at": "örnek",
"terms_accepted_at": "örnek",
"terms_version": "örnek",
"audiences": 1,
"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/ads/accounts" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Ad audiences
Authentication: API key — scope segments:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
ad_account_id | query | string | No | Length: 1–64 | "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdAudienceList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].ad_account_id | string | Yes | |
data[].platform | enum | Yes | Values: "meta", "google", "tiktok", "linkedin" |
data[].source | enum | Yes | Values: "segment", "journey", "lookalike" |
data[].segment_id | string | null | Yes | |
data[].segment_name | string | null | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].external_id | string | null | Yes | |
data[].status | enum | Yes | Values: "pending", "active", "paused", "error" |
data[].identifiers | array<enum> | Yes | |
data[].sync_interval_minutes | integer | Yes | |
data[].next_sync_at | string | null | Yes | |
data[].last_synced_at | string | null | Yes | |
data[].last_sync_status | enum | null | Yes | |
data[].full_reload_requested | boolean | Yes | |
data[].member_count | integer | Yes | |
data[].estimated_size | integer | null | Yes | |
data[].match_rate | number | null | Yes | |
data[].size_updated_at | string | null | Yes | |
data[].lookalike_source_id | string | null | Yes | |
data[].lookalike_spec | object | null | Yes | |
data[].consecutive_failures | integer | Yes | |
data[].last_error | string | null | Yes | |
data[].last_error_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"status": "pending",
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform": "meta",
"source": "segment",
"segment_id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"segment_name": "örnek",
"description": "Sipariş durumu güncellemeleri",
"external_id": "user_42",
"identifiers": [
"email"
],
"sync_interval_minutes": 1,
"next_sync_at": "örnek",
"last_synced_at": "örnek",
"last_sync_status": "succeeded",
"full_reload_requested": true,
"member_count": 1,
"estimated_size": 1,
"match_rate": 1.5,
"size_updated_at": "örnek",
"lookalike_source_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"lookalike_spec": {
"country": "TR",
"ratio": 1.5
},
"consecutive_failures": 1,
"last_error": "örnek",
"last_error_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/ads/audiences" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create an ad audience
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: CreateAdAudienceDto
| Field | Type | Required | Description |
|---|---|---|---|
ad_account_id | string | Yes | Length: 1–64 |
source | enum | Yes | Values: "segment", "journey" |
segment_id | string | No | Length: 1–64 |
name | string | Yes | Length: 1–120 |
description | string | No | Length: 0–500 |
identifiers | array<enum> | No | Items: 1–3 |
sync_interval_minutes | integer | No | Range: 60–360 |
Example:
{
"name": "Sipariş bildirimleri",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"source": "segment",
"segment_id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"identifiers": [
"email"
],
"sync_interval_minutes": 60
}Responses
201 — Success.
Schema: AdAudience
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
ad_account_id | string | Yes | |
platform | enum | Yes | Values: "meta", "google", "tiktok", "linkedin" |
source | enum | Yes | Values: "segment", "journey", "lookalike" |
segment_id | string | null | Yes | |
segment_name | string | null | Yes | |
name | string | Yes | |
description | string | null | Yes | |
external_id | string | null | Yes | |
status | enum | Yes | Values: "pending", "active", "paused", "error" |
identifiers | array<enum> | Yes | |
sync_interval_minutes | integer | Yes | |
next_sync_at | string | null | Yes | |
last_synced_at | string | null | Yes | |
last_sync_status | enum | null | Yes | |
full_reload_requested | boolean | Yes | |
member_count | integer | Yes | |
estimated_size | integer | null | Yes | |
match_rate | number | null | Yes | |
size_updated_at | string | null | Yes | |
lookalike_source_id | string | null | Yes | |
lookalike_spec | object | null | Yes | |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
last_error_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "pending",
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform": "meta",
"source": "segment",
"segment_id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"segment_name": "örnek",
"description": "Sipariş durumu güncellemeleri",
"external_id": "user_42",
"identifiers": [
"email"
],
"sync_interval_minutes": 1,
"next_sync_at": "örnek",
"last_synced_at": "örnek",
"last_sync_status": "succeeded",
"full_reload_requested": true,
"member_count": 1,
"estimated_size": 1,
"match_rate": 1.5,
"size_updated_at": "örnek",
"lookalike_source_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"lookalike_spec": {
"country": "TR",
"ratio": 1.5
},
"consecutive_failures": 1,
"last_error": "örnek",
"last_error_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/ads/audiences" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"source": "segment",
"segment_id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"identifiers": [
"email"
],
"sync_interval_minutes": 60
}'Ad audience details
Authentication: API key — scope segments:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
audienceId | path | string | Yes | "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdAudience
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
ad_account_id | string | Yes | |
platform | enum | Yes | Values: "meta", "google", "tiktok", "linkedin" |
source | enum | Yes | Values: "segment", "journey", "lookalike" |
segment_id | string | null | Yes | |
segment_name | string | null | Yes | |
name | string | Yes | |
description | string | null | Yes | |
external_id | string | null | Yes | |
status | enum | Yes | Values: "pending", "active", "paused", "error" |
identifiers | array<enum> | Yes | |
sync_interval_minutes | integer | Yes | |
next_sync_at | string | null | Yes | |
last_synced_at | string | null | Yes | |
last_sync_status | enum | null | Yes | |
full_reload_requested | boolean | Yes | |
member_count | integer | Yes | |
estimated_size | integer | null | Yes | |
match_rate | number | null | Yes | |
size_updated_at | string | null | Yes | |
lookalike_source_id | string | null | Yes | |
lookalike_spec | object | null | Yes | |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
last_error_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "pending",
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform": "meta",
"source": "segment",
"segment_id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"segment_name": "örnek",
"description": "Sipariş durumu güncellemeleri",
"external_id": "user_42",
"identifiers": [
"email"
],
"sync_interval_minutes": 1,
"next_sync_at": "örnek",
"last_synced_at": "örnek",
"last_sync_status": "succeeded",
"full_reload_requested": true,
"member_count": 1,
"estimated_size": 1,
"match_rate": 1.5,
"size_updated_at": "örnek",
"lookalike_source_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"lookalike_spec": {
"country": "TR",
"ratio": 1.5
},
"consecutive_failures": 1,
"last_error": "örnek",
"last_error_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/ads/audiences/adu_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update an ad audience
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
audienceId | path | string | Yes | "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateAdAudienceDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–120 |
description | string | null | No | |
segment_id | string | No | Length: 1–64 |
identifiers | array<enum> | No | Items: 1–3 |
sync_interval_minutes | integer | No | Range: 60–360 |
status | enum | No | Values: "active", "paused" |
Example:
{
"name": "Sipariş bildirimleri",
"status": "active",
"description": "Sipariş durumu güncellemeleri",
"segment_id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"identifiers": [
"email"
]
}Responses
200 — Success.
Schema: AdAudience
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
ad_account_id | string | Yes | |
platform | enum | Yes | Values: "meta", "google", "tiktok", "linkedin" |
source | enum | Yes | Values: "segment", "journey", "lookalike" |
segment_id | string | null | Yes | |
segment_name | string | null | Yes | |
name | string | Yes | |
description | string | null | Yes | |
external_id | string | null | Yes | |
status | enum | Yes | Values: "pending", "active", "paused", "error" |
identifiers | array<enum> | Yes | |
sync_interval_minutes | integer | Yes | |
next_sync_at | string | null | Yes | |
last_synced_at | string | null | Yes | |
last_sync_status | enum | null | Yes | |
full_reload_requested | boolean | Yes | |
member_count | integer | Yes | |
estimated_size | integer | null | Yes | |
match_rate | number | null | Yes | |
size_updated_at | string | null | Yes | |
lookalike_source_id | string | null | Yes | |
lookalike_spec | object | null | Yes | |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
last_error_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "pending",
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform": "meta",
"source": "segment",
"segment_id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"segment_name": "örnek",
"description": "Sipariş durumu güncellemeleri",
"external_id": "user_42",
"identifiers": [
"email"
],
"sync_interval_minutes": 1,
"next_sync_at": "örnek",
"last_synced_at": "örnek",
"last_sync_status": "succeeded",
"full_reload_requested": true,
"member_count": 1,
"estimated_size": 1,
"match_rate": 1.5,
"size_updated_at": "örnek",
"lookalike_source_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"lookalike_spec": {
"country": "TR",
"ratio": 1.5
},
"consecutive_failures": 1,
"last_error": "örnek",
"last_error_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/ads/audiences/adu_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"status": "active",
"description": "Sipariş durumu güncellemeleri",
"segment_id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"identifiers": [
"email"
]
}'Delete an ad audience
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
audienceId | path | string | Yes | "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
delete_on_platform | query | enum | No | Values: "true", "false" | "true" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdOk
| 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/ads/audiences/adu_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Run the sync now
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
audienceId | path | string | Yes | "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SyncAdAudienceDto
| Field | Type | Required | Description |
|---|---|---|---|
full | boolean | No |
Example:
{
"full": true
}Responses
202 — Success.
Schema: AdAudienceSyncQueued
| Field | Type | Required | Description |
|---|---|---|---|
queued | true | Yes | |
next_sync_at | string | Yes | |
mode | enum | Yes | Values: "incremental", "full" |
Example response:
{
"queued": true,
"next_sync_at": "örnek",
"mode": "incremental"
}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/ads/audiences/adu_01JD3W5Q7X9K2M4N6P8R0T1V3W/sync" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"full": true
}'Sync history
Authentication: API key — scope segments:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
audienceId | path | string | Yes | "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
limit | query | integer | No | Range: 1–100 | 50 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdAudienceSyncList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].audience_id | string | Yes | |
data[].trigger | enum | Yes | Values: "schedule", "manual", "journey" |
data[].mode | enum | Yes | Values: "incremental", "full" |
data[].status | enum | Yes | Values: "running", "succeeded", "partial", "failed" |
data[].added | integer | Yes | |
data[].removed | integer | Yes | |
data[].failed | integer | Yes | |
data[].skipped_no_consent | integer | Yes | |
data[].skipped_no_identifier | integer | Yes | |
data[].batches | integer | Yes | |
data[].retries | integer | Yes | |
data[].error | string | null | Yes | |
data[].started_at | string | Yes | |
data[].finished_at | string | null | Yes | |
data[].duration_ms | integer | null | Yes |
Example response:
{
"data": [
{
"status": "running",
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"audience_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"trigger": "schedule",
"mode": "incremental",
"added": 1,
"removed": 1,
"failed": 1,
"skipped_no_consent": 1,
"skipped_no_identifier": 1,
"batches": 1,
"retries": 1,
"error": "örnek",
"started_at": "örnek",
"finished_at": "örnek",
"duration_ms": 1
}
]
}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/ads/audiences/adu_01JD3W5Q7X9K2M4N6P8R0T1V3W/syncs?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a lookalike audience
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
audienceId | path | string | Yes | "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateLookalikeDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–120 |
country | string | Yes | |
ratio | number | Yes | Range: 0.01–0.2 |
Example:
{
"country": "TR",
"ratio": 0.2,
"name": "Sipariş bildirimleri"
}Responses
201 — Success.
Schema: AdAudience
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
ad_account_id | string | Yes | |
platform | enum | Yes | Values: "meta", "google", "tiktok", "linkedin" |
source | enum | Yes | Values: "segment", "journey", "lookalike" |
segment_id | string | null | Yes | |
segment_name | string | null | Yes | |
name | string | Yes | |
description | string | null | Yes | |
external_id | string | null | Yes | |
status | enum | Yes | Values: "pending", "active", "paused", "error" |
identifiers | array<enum> | Yes | |
sync_interval_minutes | integer | Yes | |
next_sync_at | string | null | Yes | |
last_synced_at | string | null | Yes | |
last_sync_status | enum | null | Yes | |
full_reload_requested | boolean | Yes | |
member_count | integer | Yes | |
estimated_size | integer | null | Yes | |
match_rate | number | null | Yes | |
size_updated_at | string | null | Yes | |
lookalike_source_id | string | null | Yes | |
lookalike_spec | object | null | Yes | |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
last_error_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "pending",
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform": "meta",
"source": "segment",
"segment_id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"segment_name": "örnek",
"description": "Sipariş durumu güncellemeleri",
"external_id": "user_42",
"identifiers": [
"email"
],
"sync_interval_minutes": 1,
"next_sync_at": "örnek",
"last_synced_at": "örnek",
"last_sync_status": "succeeded",
"full_reload_requested": true,
"member_count": 1,
"estimated_size": 1,
"match_rate": 1.5,
"size_updated_at": "örnek",
"lookalike_source_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"lookalike_spec": {
"country": "TR",
"ratio": 1.5
},
"consecutive_failures": 1,
"last_error": "örnek",
"last_error_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/ads/audiences/adu_01JD3W5Q7X9K2M4N6P8R0T1V3W/lookalikes" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"country": "TR",
"ratio": 0.2,
"name": "Sipariş bildirimleri"
}'Campaign / ad set / ad list and metrics
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
ad_account_id | query | string | No | Length: 1–64 | "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
level | query | enum | No | Values: "campaign", "ad_set", "ad" | "campaign" |
parent_id | query | string | No | Length: 1–100 | "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
status | query | enum | No | Values: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown" | "active" |
q | query | string | No | Length: 0–100 | "ayse" |
from | query | string | No | "2026-10-01T00:00:00Z" | |
to | query | string | No | "2026-10-17T00:00:00Z" | |
limit | query | integer | No | Range: 1–500 | 50 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdEntityList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].ad_account_id | string | Yes | |
data[].platform | enum | Yes | Values: "meta", "google", "tiktok" |
data[].level | enum | Yes | Values: "campaign", "ad_set", "ad" |
data[].external_id | string | Yes | |
data[].campaign_external_id | string | Yes | |
data[].ad_set_external_id | string | null | Yes | |
data[].name | string | Yes | |
data[].status | enum | Yes | Values: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown" |
data[].platform_status | string | null | Yes | |
data[].objective | string | null | Yes | |
data[].optimization_goal | string | null | Yes | |
data[].currency | string | null | Yes | |
data[].daily_budget | string | null | Yes | |
data[].lifetime_budget | string | null | Yes | |
data[].start_at | string | null | Yes | |
data[].end_at | string | null | Yes | |
data[].audience_external_ids | array<string> | Yes | |
data[].creative | object | null | Yes | |
data[].budget_editable | boolean | Yes | |
data[].created_by_pushizo | boolean | Yes | |
data[].last_seen_at | string | null | Yes | |
data[].platform_url | string | Yes | |
data[].metrics | object | null | Yes | |
data[].updated_at | string | Yes | |
from | string | Yes | |
to | string | Yes | |
accounts | array<object> | Yes | |
accounts[].id | string | Yes | |
accounts[].campaigns_synced_at | string | null | Yes | |
accounts[].insights_synced_at | string | null | Yes | |
accounts[].campaigns_sync_error | string | null | Yes | |
accounts[].insights_sync_error | string | null | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform": "meta",
"level": "campaign",
"external_id": "user_42",
"campaign_external_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"ad_set_external_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform_status": "örnek",
"objective": "örnek",
"optimization_goal": "örnek",
"currency": "TRY",
"daily_budget": "örnek",
"lifetime_budget": "örnek",
"start_at": "örnek",
"end_at": "örnek",
"audience_external_ids": [
"adu_01JD3W5Q7X9K2M4N6P8R0T1V3W"
],
"creative": {
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"description": "Sipariş durumu güncellemeleri",
"link_url": "https://pushizo.com/orders/1001",
"image_url": "https://pushizo.com/orders/1001",
"call_to_action": "örnek"
},
"budget_editable": true,
"created_by_pushizo": true,
"last_seen_at": "örnek",
"platform_url": "https://pushizo.com/orders/1001",
"metrics": {
"impressions": 1.5,
"clicks": 1.5,
"spend": 1.5,
"conversions": 1.5,
"conversion_value": 149.9,
"ctr": 1.5,
"cpc": 1.5,
"roas": 1.5
},
"updated_at": "örnek"
}
],
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"accounts": [
{
"id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"campaigns_synced_at": "örnek",
"insights_synced_at": "örnek",
"campaigns_sync_error": "örnek",
"insights_sync_error": "ö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/ads/campaigns?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create an ad campaign: campaign + ad set (Pushizo audience) + creative/ad
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: CreateAdCampaignDto
| Field | Type | Required | Description |
|---|---|---|---|
ad_account_id | string | Yes | Length: 1–64 |
audience_id | string | Yes | Length: 1–64 |
name | string | Yes | Length: 1–200 |
objective | enum | Yes | Values: "traffic", "conversions", "leads", "awareness" |
optimization_goal | enum | No | Values: "clicks", "landing_page_views", "conversions", "reach", "impressions" |
daily_budget | string | number | Yes | |
start_at | string (date-time) | No | |
end_at | string (date-time) | No | |
countries | array<string> | Yes | Items: 1–25 |
status | enum | No | Values: "active", "paused" |
pixel_id | string | No | Length: 1–64 |
creative | object | No | |
creative.headline | string | Yes | Length: 1–30 |
creative.long_headline | string | No | Length: 1–90 |
creative.primary_text | string | Yes | Length: 1–500 |
creative.description | string | No | Length: 1–90 |
creative.link_url | string (uri) | Yes | |
creative.call_to_action | enum | Yes | Values: "LEARN_MORE", "SHOP_NOW", "SIGN_UP", "SUBSCRIBE", "DOWNLOAD", "CONTACT_US", "BOOK_NOW", "GET_OFFER" |
creative.image_id | string | No | Length: 1–64 |
creative.square_image_id | string | No | Length: 1–64 |
creative.page_id | string | No | Length: 1–64 |
creative.business_name | string | No | Length: 1–25 |
Example:
{
"name": "Sipariş bildirimleri",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"audience_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"objective": "traffic",
"daily_budget": "değer",
"countries": [
"değer"
],
"status": "active",
"optimization_goal": "clicks",
"start_at": "2026-10-17T09:00:00Z",
"end_at": "2026-10-17T09:00:00Z",
"pixel_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}Responses
201 — Success.
Schema: AdCampaignCreated
| Field | Type | Required | Description |
|---|---|---|---|
campaign | object | Yes | |
campaign.id | string | Yes | |
campaign.app_id | string | Yes | |
campaign.ad_account_id | string | Yes | |
campaign.platform | enum | Yes | Values: "meta", "google", "tiktok" |
campaign.level | enum | Yes | Values: "campaign", "ad_set", "ad" |
campaign.external_id | string | Yes | |
campaign.campaign_external_id | string | Yes | |
campaign.ad_set_external_id | string | null | Yes | |
campaign.name | string | Yes | |
campaign.status | enum | Yes | Values: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown" |
campaign.platform_status | string | null | Yes | |
campaign.objective | string | null | Yes | |
campaign.optimization_goal | string | null | Yes | |
campaign.currency | string | null | Yes | |
campaign.daily_budget | string | null | Yes | |
campaign.lifetime_budget | string | null | Yes | |
campaign.start_at | string | null | Yes | |
campaign.end_at | string | null | Yes | |
campaign.audience_external_ids | array<string> | Yes | |
campaign.creative | object | null | Yes | |
campaign.budget_editable | boolean | Yes | |
campaign.created_by_pushizo | boolean | Yes | |
campaign.last_seen_at | string | null | Yes | |
campaign.platform_url | string | Yes | |
campaign.metrics | object | null | Yes | |
campaign.updated_at | string | Yes | |
ad_set_id | string | Yes | |
ad_id | string | null | Yes | |
warnings | array<string> | Yes | |
platform_url | string | Yes |
Example response:
{
"campaign": {
"name": "Sipariş bildirimleri",
"status": "active",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform": "meta",
"level": "campaign",
"external_id": "user_42",
"campaign_external_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"ad_set_external_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform_status": "örnek",
"objective": "örnek",
"optimization_goal": "örnek",
"currency": "TRY",
"daily_budget": "örnek",
"lifetime_budget": "örnek",
"start_at": "örnek",
"end_at": "örnek",
"audience_external_ids": [
"adu_01JD3W5Q7X9K2M4N6P8R0T1V3W"
],
"creative": {
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"description": "Sipariş durumu güncellemeleri",
"link_url": "https://pushizo.com/orders/1001",
"image_url": "https://pushizo.com/orders/1001",
"call_to_action": "örnek"
},
"budget_editable": true,
"created_by_pushizo": true,
"last_seen_at": "örnek",
"platform_url": "https://pushizo.com/orders/1001",
"metrics": {
"impressions": 1.5,
"clicks": 1.5,
"spend": 1.5,
"conversions": 1.5,
"conversion_value": 149.9,
"ctr": 1.5,
"cpc": 1.5,
"roas": 1.5
},
"updated_at": "örnek"
},
"ad_set_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"ad_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"warnings": [
"örnek"
],
"platform_url": "https://pushizo.com/orders/1001"
}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/ads/campaigns" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"audience_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"objective": "traffic",
"daily_budget": "değer",
"countries": [
"değer"
],
"status": "active",
"optimization_goal": "clicks",
"start_at": "2026-10-17T09:00:00Z",
"end_at": "2026-10-17T09:00:00Z",
"pixel_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'Campaign / ad set / ad details
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
entityId | path | string | Yes | "ade_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdEntity
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
ad_account_id | string | Yes | |
platform | enum | Yes | Values: "meta", "google", "tiktok" |
level | enum | Yes | Values: "campaign", "ad_set", "ad" |
external_id | string | Yes | |
campaign_external_id | string | Yes | |
ad_set_external_id | string | null | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown" |
platform_status | string | null | Yes | |
objective | string | null | Yes | |
optimization_goal | string | null | Yes | |
currency | string | null | Yes | |
daily_budget | string | null | Yes | |
lifetime_budget | string | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
audience_external_ids | array<string> | Yes | |
creative | object | null | Yes | |
budget_editable | boolean | Yes | |
created_by_pushizo | boolean | Yes | |
last_seen_at | string | null | Yes | |
platform_url | string | Yes | |
metrics | object | null | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "ade_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform": "meta",
"level": "campaign",
"external_id": "user_42",
"campaign_external_id": "ade_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"ad_set_external_id": "ade_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform_status": "örnek",
"objective": "örnek",
"optimization_goal": "örnek",
"currency": "TRY",
"daily_budget": "örnek",
"lifetime_budget": "örnek",
"start_at": "örnek",
"end_at": "örnek",
"audience_external_ids": [
"adu_01JD3W5Q7X9K2M4N6P8R0T1V3W"
],
"creative": {
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"description": "Sipariş durumu güncellemeleri",
"link_url": "https://pushizo.com/orders/1001",
"image_url": "https://pushizo.com/orders/1001",
"call_to_action": "örnek"
},
"budget_editable": true,
"created_by_pushizo": true,
"last_seen_at": "örnek",
"platform_url": "https://pushizo.com/orders/1001",
"metrics": {
"impressions": 1.5,
"clicks": 1.5,
"spend": 1.5,
"conversions": 1.5,
"conversion_value": 149.9,
"ctr": 1.5,
"cpc": 1.5,
"roas": 1.5
},
"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/ads/campaigns/ade_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Change status and daily budget
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
entityId | path | string | Yes | "ade_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateAdCampaignDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | No | Values: "active", "paused" |
daily_budget | string | number | No |
Example:
{
"status": "active",
"daily_budget": "değer"
}Responses
200 — Success.
Schema: AdEntity
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
ad_account_id | string | Yes | |
platform | enum | Yes | Values: "meta", "google", "tiktok" |
level | enum | Yes | Values: "campaign", "ad_set", "ad" |
external_id | string | Yes | |
campaign_external_id | string | Yes | |
ad_set_external_id | string | null | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown" |
platform_status | string | null | Yes | |
objective | string | null | Yes | |
optimization_goal | string | null | Yes | |
currency | string | null | Yes | |
daily_budget | string | null | Yes | |
lifetime_budget | string | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
audience_external_ids | array<string> | Yes | |
creative | object | null | Yes | |
budget_editable | boolean | Yes | |
created_by_pushizo | boolean | Yes | |
last_seen_at | string | null | Yes | |
platform_url | string | Yes | |
metrics | object | null | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "ade_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform": "meta",
"level": "campaign",
"external_id": "user_42",
"campaign_external_id": "ade_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"ad_set_external_id": "ade_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform_status": "örnek",
"objective": "örnek",
"optimization_goal": "örnek",
"currency": "TRY",
"daily_budget": "örnek",
"lifetime_budget": "örnek",
"start_at": "örnek",
"end_at": "örnek",
"audience_external_ids": [
"adu_01JD3W5Q7X9K2M4N6P8R0T1V3W"
],
"creative": {
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"description": "Sipariş durumu güncellemeleri",
"link_url": "https://pushizo.com/orders/1001",
"image_url": "https://pushizo.com/orders/1001",
"call_to_action": "örnek"
},
"budget_editable": true,
"created_by_pushizo": true,
"last_seen_at": "örnek",
"platform_url": "https://pushizo.com/orders/1001",
"metrics": {
"impressions": 1.5,
"clicks": 1.5,
"spend": 1.5,
"conversions": 1.5,
"conversion_value": 149.9,
"ctr": 1.5,
"cpc": 1.5,
"roas": 1.5
},
"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/ads/campaigns/ade_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "active",
"daily_budget": "değer"
}'Creative preview (platform preview link + creative summary)
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
entityId | path | string | Yes | "ade_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdCampaignPreview
| Field | Type | Required | Description |
|---|---|---|---|
preview_url | string | null | Yes | |
platform_url | string | Yes | |
creative | object | null | Yes |
Example response:
{
"preview_url": "https://pushizo.com/orders/1001",
"platform_url": "https://pushizo.com/orders/1001",
"creative": {
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"description": "Sipariş durumu güncellemeleri",
"link_url": "https://pushizo.com/orders/1001",
"image_url": "https://pushizo.com/orders/1001",
"call_to_action": "ö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/ads/campaigns/ade_01JD3W5Q7X9K2M4N6P8R0T1V3W/preview" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Meta: Facebook pages the account can promote
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
accountId | path | string | Yes | "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdPageList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
]
}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/ads/accounts/ada_01JD3W5Q7X9K2M4N6P8R0T1V3W/pages" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Uploaded creative images
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
| Field | Type | Required | Description |
|---|---|---|---|
data | array<AdCreative> | No | |
data[].id | string | Yes | |
data[].file_name | string | null | Yes | |
data[].content_type | string | Yes | |
data[].bytes | integer | Yes | |
data[].width | integer | null | Yes | |
data[].height | integer | null | Yes | |
data[].preview_url | string | Yes | |
data[].created_at | string | Yes |
Example response:
{
"data": [
{
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"file_name": "örnek",
"content_type": "örnek",
"bytes": 1,
"width": 1,
"height": 1,
"preview_url": "https://pushizo.com/orders/1001",
"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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/ads/creatives" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Upload a creative image (multipart file: PNG/JPEG, up to 5 MB)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
201 — Success.
Schema: AdCreative
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
file_name | string | null | Yes | |
content_type | string | Yes | |
bytes | integer | Yes | |
width | integer | null | Yes | |
height | integer | null | Yes | |
preview_url | string | Yes | |
created_at | string | Yes |
Example response:
{
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"file_name": "örnek",
"content_type": "örnek",
"bytes": 1,
"width": 1,
"height": 1,
"preview_url": "https://pushizo.com/orders/1001",
"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/ads/creatives" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Reporting currency (organization) and attribution defaults (app)
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdReportingSettings
| Field | Type | Required | Description |
|---|---|---|---|
reporting_currency | string | Yes | |
attribution_model | enum | Yes | Values: "last_click", "first_click", "linear", "time_decay" |
window_days | integer | Yes | |
half_life_days | integer | Yes | |
conversion_events | array<string> | Yes | |
effective_conversion_events | array<string> | Yes | |
fx | object | Yes | |
fx.latest_day | string | null | Yes | |
fx.source | string | null | Yes |
Example response:
{
"reporting_currency": "örnek",
"attribution_model": "last_click",
"window_days": 1,
"half_life_days": 1,
"conversion_events": [
"örnek"
],
"effective_conversion_events": [
"örnek"
],
"fx": {
"latest_day": "örnek",
"source": "ö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/ads/settings" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update the reporting currency and attribution defaults
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: AdReportingSettingsInputDto
| Field | Type | Required | Description |
|---|---|---|---|
reporting_currency | string | No | |
attribution_model | enum | No | Values: "last_click", "first_click", "linear", "time_decay" |
window_days | integer | No | Range: 1–90 |
half_life_days | integer | No | Range: 1–30 |
conversion_events | array<string> | No | Items: 0–20 |
Example:
{
"reporting_currency": "değer",
"attribution_model": "last_click",
"window_days": 1,
"half_life_days": 1,
"conversion_events": [
"örnek"
]
}Responses
200 — Success.
Schema: AdReportingSettings
| Field | Type | Required | Description |
|---|---|---|---|
reporting_currency | string | Yes | |
attribution_model | enum | Yes | Values: "last_click", "first_click", "linear", "time_decay" |
window_days | integer | Yes | |
half_life_days | integer | Yes | |
conversion_events | array<string> | Yes | |
effective_conversion_events | array<string> | Yes | |
fx | object | Yes | |
fx.latest_day | string | null | Yes | |
fx.source | string | null | Yes |
Example response:
{
"reporting_currency": "örnek",
"attribution_model": "last_click",
"window_days": 1,
"half_life_days": 1,
"conversion_events": [
"örnek"
],
"effective_conversion_events": [
"örnek"
],
"fx": {
"latest_day": "örnek",
"source": "ö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 PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/ads/settings" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"reporting_currency": "değer",
"attribution_model": "last_click",
"window_days": 1,
"half_life_days": 1,
"conversion_events": [
"örnek"
]
}'Send a synthetic test event to the platform's test tool
/v1/apps/{appId}/ads/conversions-api/configs/{configId}/testTry it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
configId | path | string | Yes | "cac_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdCapiTestResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes | |
response | map<string, any> | Yes |
Example response:
{
"ok": true,
"response": {
"key": "ö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/ads/conversions-api/configs/cac_01JD3W5Q7X9K2M4N6P8R0T1V3W/test" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Retry a failed delivery
/v1/apps/{appId}/ads/conversions-api/deliveries/{deliveryId}/retryTry it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
deliveryId | path | string | Yes | "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdCapiDelivery
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
config_id | string | Yes | |
platform | enum | Yes | Values: "meta", "google", "tiktok" |
event_id | string | Yes | |
event_name | string | Yes | |
platform_event | string | Yes | |
dedup_id | string | Yes | |
user_id | string | null | Yes | |
value | number | null | Yes | |
currency | string | null | Yes | |
status | enum | Yes | Values: "pending", "sent", "failed", "skipped" |
skip_reason | string | null | Yes | |
attempts | integer | Yes | |
next_attempt_at | string | null | Yes | |
last_error | string | null | Yes | |
test | boolean | Yes | |
event_occurred_at | string | Yes | |
sent_at | string | null | Yes | |
created_at | string | Yes |
Example response:
{
"status": "pending",
"id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"config_id": "cac_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform": "meta",
"event_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"event_name": "purchase",
"platform_event": "örnek",
"dedup_id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"value": 149.9,
"currency": "TRY",
"skip_reason": "örnek",
"attempts": 1,
"next_attempt_at": "örnek",
"last_error": "örnek",
"test": true,
"event_occurred_at": "örnek",
"sent_at": "örnek",
"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/ads/conversions-api/deliveries/dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W/retry" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Refresh campaigns and metrics now
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
accountId | path | string | Yes | "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
202 — Success.
Schema: AdRefreshQueued
| Field | Type | Required | Description |
|---|---|---|---|
queued | true | Yes | |
next_sync_at | string | Yes |
Example response:
{
"queued": true,
"next_sync_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/ads/accounts/ada_01JD3W5Q7X9K2M4N6P8R0T1V3W/refresh" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Spend and performance report
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
from | query | string | Yes | "2026-10-01T00:00:00Z" | |
to | query | string | Yes | "2026-10-17T00:00:00Z" | |
currency | query | string | No | "TRY" | |
group_by | query | enum | No | Values: "day", "platform", "account", "campaign", "ad_set" | "day" |
ad_account_id | query | string | No | Length: 1–64 | "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
campaign_id | query | string | No | Length: 1–100 | "ade_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdSpendReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
currency | string | Yes | |
group_by | string | Yes | |
rows | array<object> | Yes | |
rows[].key | string | Yes | |
rows[].label | string | Yes | |
rows[].platform | string | null | Yes | |
rows[].impressions | number | Yes | |
rows[].clicks | number | Yes | |
rows[].spend | number | Yes | |
rows[].conversions | number | Yes | |
rows[].conversion_value | number | Yes | |
rows[].ctr | number | null | Yes | |
rows[].cpc | number | null | Yes | |
rows[].cpa | number | null | Yes | |
rows[].roas | number | null | Yes | |
totals | object | Yes | |
totals.impressions | number | Yes | |
totals.clicks | number | Yes | |
totals.spend | number | Yes | |
totals.conversions | number | Yes | |
totals.conversion_value | number | Yes | |
totals.ctr | number | null | Yes | |
totals.cpc | number | null | Yes | |
totals.cpa | number | null | Yes | |
totals.roas | number | null | Yes | |
fx_missing | array<string> | Yes | |
store | enum | Yes | Values: "postgres", "clickhouse" |
Example response:
{
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"currency": "TRY",
"group_by": "örnek",
"rows": [
{
"key": "key-2026-10",
"label": "external_id",
"platform": "örnek",
"impressions": 1.5,
"clicks": 1.5,
"spend": 1.5,
"conversions": 1.5,
"conversion_value": 149.9,
"ctr": 1.5,
"cpc": 1.5,
"cpa": 1.5,
"roas": 1.5
}
],
"totals": {
"impressions": 1.5,
"clicks": 1.5,
"spend": 1.5,
"conversions": 1.5,
"conversion_value": 149.9,
"ctr": 1.5,
"cpc": 1.5,
"cpa": 1.5,
"roas": 1.5
},
"fx_missing": [
"örnek"
],
"store": "postgres"
}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/ads/reports/spend?from=2026-10-01T00%3A00%3A00Z&to=2026-10-17T00%3A00%3A00Z" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Unified attribution report (ROAS, CAC)
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
from | query | string | Yes | "2026-10-01T00:00:00Z" | |
to | query | string | Yes | "2026-10-17T00:00:00Z" | |
model | query | enum | No | Values: "last_click", "first_click", "linear", "time_decay" | "last_click" |
window_days | query | integer | No | Range: 1–90 | 1 |
half_life_days | query | integer | No | Range: 1–30 | 1 |
currency | query | string | No | "TRY" | |
group_by | query | enum | No | Values: "channel", "campaign", "ad_set" | "channel" |
conversion_events | query | string | No | Length: 0–1000 | "örnek" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdAttributionReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
model | enum | Yes | Values: "last_click", "first_click", "linear", "time_decay" |
window_days | integer | Yes | |
half_life_days | integer | Yes | |
currency | string | Yes | |
group_by | string | Yes | |
conversion_events | array<string> | Yes | |
rows | array<object> | Yes | |
rows[].key | string | Yes | |
rows[].channel | enum | Yes | Values: "meta", "google", "tiktok", "linkedin", "microsoft", "other_paid", "utm", "push", "email", "sms", "whatsapp", "rcs", "direct" |
rows[].label | string | Yes | |
rows[].paid | boolean | Yes | |
rows[].conversions | number | Yes | |
rows[].revenue | number | Yes | |
rows[].new_customers | number | Yes | |
rows[].spend | number | null | Yes | |
rows[].roas | number | null | Yes | |
rows[].cac | number | null | Yes | |
totals | object | Yes | |
totals.conversions | number | Yes | |
totals.revenue | number | Yes | |
totals.spend | number | Yes | |
totals.new_customers | number | Yes | |
totals.roas | number | null | Yes | |
totals.platform_roas | number | null | Yes | |
totals.cac | number | null | Yes | |
totals.paid_cac | number | null | Yes | |
truncated | boolean | Yes | |
fx_missing | array<string> | Yes |
Example response:
{
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"model": "last_click",
"window_days": 1,
"half_life_days": 1,
"currency": "TRY",
"group_by": "örnek",
"conversion_events": [
"örnek"
],
"rows": [
{
"channel": "meta",
"key": "key-2026-10",
"label": "external_id",
"paid": true,
"conversions": 1.5,
"revenue": 149.9,
"new_customers": 1.5,
"spend": 1.5,
"roas": 1.5,
"cac": 1.5
}
],
"totals": {
"conversions": 1.5,
"revenue": 149.9,
"spend": 1.5,
"new_customers": 1.5,
"roas": 1.5,
"platform_roas": 1.5,
"cac": 1.5,
"paid_cac": 1.5
},
"truncated": true,
"fx_missing": [
"ö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/ads/reports/attribution?from=2026-10-01T00%3A00%3A00Z&to=2026-10-17T00%3A00%3A00Z" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Cohort LTV report
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
months | query | integer | No | Range: 1–24 | 1 |
cohorts | query | integer | No | Range: 1–12 | 1 |
currency | query | string | No | "TRY" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdLtvReport
| Field | Type | Required | Description |
|---|---|---|---|
currency | string | Yes | |
months | integer | Yes | |
conversion_events | array<string> | Yes | |
cohorts | array<object> | Yes | |
cohorts[].cohort | string | Yes | |
cohorts[].size | integer | Yes | |
cohorts[].revenue | array<number> | Yes | |
cohorts[].ltv | array<number> | Yes | |
average | array<number | null> | Yes | |
fx_missing | array<string> | Yes |
Example response:
{
"currency": "TRY",
"months": 1,
"conversion_events": [
"örnek"
],
"cohorts": [
{
"cohort": "örnek",
"size": 1,
"revenue": [
149.9
],
"ltv": [
1.5
]
}
],
"average": [
1.5
],
"fx_missing": [
"ö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/ads/reports/ltv" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Conversions API configurations
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdCapiConfigList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].platform | enum | Yes | Values: "meta", "google", "tiktok" |
data[].name | string | Yes | |
data[].ad_account_id | string | null | Yes | |
data[].enabled | boolean | Yes | |
data[].settings | object | Yes | |
data[].settings.pixel_id | string | null | Yes | |
data[].settings.customer_id | string | null | Yes | |
data[].settings.login_customer_id | string | null | Yes | |
data[].settings.pixel_code | string | null | Yes | |
data[].event_mappings | array<object> | Yes | |
data[].event_mappings[].event_name | string | Yes | |
data[].event_mappings[].platform_event | string | Yes | |
data[].event_mappings[].value_property | string | null | Yes | |
data[].event_mappings[].currency_property | string | null | Yes | |
data[].test_event_code | string | null | Yes | |
data[].test_mode | boolean | Yes | |
data[].action_source | enum | Yes | Values: "website", "app" |
data[].default_currency | string | Yes | |
data[].has_access_token | boolean | Yes | |
data[].last_sent_at | string | null | Yes | |
data[].last_error | string | null | Yes | |
data[].last_error_at | string | null | Yes | |
data[].stats | object | Yes | |
data[].stats.pending | integer | Yes | |
data[].stats.sent | integer | Yes | |
data[].stats.failed | integer | Yes | |
data[].stats.skipped | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"enabled": true,
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform": "meta",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"settings": {
"pixel_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"customer_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"login_customer_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"pixel_code": "örnek"
},
"event_mappings": [
{
"event_name": "purchase",
"platform_event": "örnek",
"value_property": "örnek",
"currency_property": "örnek"
}
],
"test_event_code": "örnek",
"test_mode": true,
"action_source": "website",
"default_currency": "örnek",
"has_access_token": true,
"last_sent_at": "örnek",
"last_error": "örnek",
"last_error_at": "örnek",
"stats": {
"pending": 1,
"sent": 1,
"failed": 1,
"skipped": 1
},
"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/ads/conversions-api/configs" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Conversions API delivery history
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
config_id | query | string | No | Length: 1–64 | "cac_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
status | query | enum | No | Values: "pending", "sent", "failed", "skipped" | "pending" |
limit | query | integer | No | Range: 1–200 | 50 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdCapiDeliveryList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].config_id | string | Yes | |
data[].platform | enum | Yes | Values: "meta", "google", "tiktok" |
data[].event_id | string | Yes | |
data[].event_name | string | Yes | |
data[].platform_event | string | Yes | |
data[].dedup_id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].value | number | null | Yes | |
data[].currency | string | null | Yes | |
data[].status | enum | Yes | Values: "pending", "sent", "failed", "skipped" |
data[].skip_reason | string | null | Yes | |
data[].attempts | integer | Yes | |
data[].next_attempt_at | string | null | Yes | |
data[].last_error | string | null | Yes | |
data[].test | boolean | Yes | |
data[].event_occurred_at | string | Yes | |
data[].sent_at | string | null | Yes | |
data[].created_at | string | Yes |
Example response:
{
"data": [
{
"status": "pending",
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"config_id": "cac_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"platform": "meta",
"event_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"event_name": "purchase",
"platform_event": "örnek",
"dedup_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"value": 149.9,
"currency": "TRY",
"skip_reason": "örnek",
"attempts": 1,
"next_attempt_at": "örnek",
"last_error": "örnek",
"test": true,
"event_occurred_at": "örnek",
"sent_at": "örnek",
"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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/ads/conversions-api/deliveries?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Budget alert rules
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdBudgetAlertRuleList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].kind | enum | Yes | Values: "daily_spend", "roas_drop", "budget_depletion" |
data[].ad_account_id | string | null | Yes | |
data[].campaign_external_id | string | null | Yes | |
data[].threshold | number | Yes | |
data[].window_days | integer | Yes | |
data[].recipients | array<string> | Yes | |
data[].enabled | boolean | Yes | |
data[].last_value | number | null | Yes | |
data[].last_evaluated_at | string | null | Yes | |
data[].last_triggered_on | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"enabled": true,
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"kind": "daily_spend",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"campaign_external_id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"threshold": 1.5,
"window_days": 1,
"recipients": [
"örnek"
],
"last_value": 149.9,
"last_evaluated_at": "örnek",
"last_triggered_on": "ö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/ads/alert-rules" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a budget alert rule
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: CreateBudgetAlertRuleDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–120 |
kind | enum | Yes | Values: "daily_spend", "roas_drop", "budget_depletion" |
ad_account_id | string | null | No | |
campaign_external_id | string | null | No | |
threshold | number | Yes | Range: −∞–1000000000000 |
window_days | integer | No | Range: 1–30 |
recipients | array<string (email)> | No | Items: 0–20 |
enabled | boolean | No |
Example:
{
"name": "Sipariş bildirimleri",
"kind": "daily_spend",
"threshold": 1.5,
"enabled": true,
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"campaign_external_id": "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"window_days": 1,
"recipients": [
"ayse@pushizo.com"
]
}Responses
201 — Success.
Schema: AdBudgetAlertRule
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "daily_spend", "roas_drop", "budget_depletion" |
ad_account_id | string | null | Yes | |
campaign_external_id | string | null | Yes | |
threshold | number | Yes | |
window_days | integer | Yes | |
recipients | array<string> | Yes | |
enabled | boolean | Yes | |
last_value | number | null | Yes | |
last_evaluated_at | string | null | Yes | |
last_triggered_on | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"id": "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"kind": "daily_spend",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"campaign_external_id": "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"threshold": 1.5,
"window_days": 1,
"recipients": [
"örnek"
],
"last_value": 149.9,
"last_evaluated_at": "örnek",
"last_triggered_on": "ö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/ads/alert-rules" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"kind": "daily_spend",
"threshold": 1.5,
"enabled": true,
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"campaign_external_id": "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"window_days": 1,
"recipients": [
"ayse@pushizo.com"
]
}'Update a budget alert rule
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
ruleId | path | string | Yes | "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateBudgetAlertRuleDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–120 |
ad_account_id | string | null | No | |
campaign_external_id | string | null | No | |
threshold | number | No | Range: −∞–1000000000000 |
window_days | integer | No | Range: 1–30 |
recipients | array<string (email)> | No | Items: 0–20 |
enabled | boolean | No |
Example:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"campaign_external_id": "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"threshold": 1.5
}Responses
200 — Success.
Schema: AdBudgetAlertRule
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "daily_spend", "roas_drop", "budget_depletion" |
ad_account_id | string | null | Yes | |
campaign_external_id | string | null | Yes | |
threshold | number | Yes | |
window_days | integer | Yes | |
recipients | array<string> | Yes | |
enabled | boolean | Yes | |
last_value | number | null | Yes | |
last_evaluated_at | string | null | Yes | |
last_triggered_on | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"id": "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"kind": "daily_spend",
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"campaign_external_id": "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"threshold": 1.5,
"window_days": 1,
"recipients": [
"örnek"
],
"last_value": 149.9,
"last_evaluated_at": "örnek",
"last_triggered_on": "ö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/ads/alert-rules/bar_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"enabled": true,
"ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"campaign_external_id": "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"threshold": 1.5
}'Delete a budget alert rule
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
ruleId | path | string | Yes | "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdOk
| 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/ads/alert-rules/bar_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Triggered budget alerts
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
rule_id | query | string | No | Length: 1–64 | "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
limit | query | integer | No | Range: 1–200 | 50 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AdBudgetAlertList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].rule_id | string | Yes | |
data[].rule_name | string | Yes | |
data[].kind | enum | Yes | Values: "daily_spend", "roas_drop", "budget_depletion" |
data[].day | string | Yes | |
data[].value | number | Yes | |
data[].threshold | number | Yes | |
data[].details | map<string, any> | Yes | |
data[].emailed | integer | Yes | |
data[].created_at | string | Yes |
Example response:
{
"data": [
{
"id": "adu_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"rule_id": "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"rule_name": "örnek",
"kind": "daily_spend",
"day": "örnek",
"value": 149.9,
"threshold": 1.5,
"details": {
"key": "örnek"
},
"emailed": 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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/ads/alerts?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"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.
Web campaigns (pop-up, banner)
Web campaigns (pop-up, banner) — 8 operations (GET /v1/apps/{appId}/web-campaigns, POST /v1/apps/{appId}/web-campaigns, GET /v1/apps/{appId}/web-campaigns/{campaignId}, …). Generated from the OpenAPI 3.1.0 contract.