PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/ads/platformsAd platforms (enabled/mock, identifiers, lookalike support)
GET/v1/apps/{appId}/ads/accountsConnected ad accounts
GET/v1/apps/{appId}/ads/audiencesAd audiences
POST/v1/apps/{appId}/ads/audiencesCreate 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}/syncRun the sync now
GET/v1/apps/{appId}/ads/audiences/{audienceId}/syncsSync history
POST/v1/apps/{appId}/ads/audiences/{audienceId}/lookalikesCreate a lookalike audience
GET/v1/apps/{appId}/ads/campaignsCampaign / ad set / ad list and metrics
POST/v1/apps/{appId}/ads/campaignsCreate 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}/previewCreative preview (platform preview link + creative summary)
GET/v1/apps/{appId}/ads/accounts/{accountId}/pagesMeta: Facebook pages the account can promote
GET/v1/apps/{appId}/ads/creativesUploaded creative images
POST/v1/apps/{appId}/ads/creativesUpload a creative image (multipart file: PNG/JPEG, up to 5 MB)
GET/v1/apps/{appId}/ads/settingsReporting currency (organization) and attribution defaults (app)
PUT/v1/apps/{appId}/ads/settingsUpdate the reporting currency and attribution defaults
POST/v1/apps/{appId}/ads/conversions-api/configs/{configId}/testSend a synthetic test event to the platform's test tool
POST/v1/apps/{appId}/ads/conversions-api/deliveries/{deliveryId}/retryRetry a failed delivery
POST/v1/apps/{appId}/ads/accounts/{accountId}/refreshRefresh campaigns and metrics now
GET/v1/apps/{appId}/ads/reports/spendSpend and performance report
GET/v1/apps/{appId}/ads/reports/attributionUnified attribution report (ROAS, CAC)
GET/v1/apps/{appId}/ads/reports/ltvCohort LTV report
GET/v1/apps/{appId}/ads/conversions-api/configsConversions API configurations
GET/v1/apps/{appId}/ads/conversions-api/deliveriesConversions API delivery history
GET/v1/apps/{appId}/ads/alert-rulesBudget alert rules
POST/v1/apps/{appId}/ads/alert-rulesCreate 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/alertsTriggered budget alerts

Details

Ad platforms (enabled/mock, identifiers, lookalike support)

GET/v1/apps/{appId}/ads/platformsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdPlatformList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].platformenumYesValues: "meta", "google", "tiktok", "linkedin"
data[].enabledbooleanYes
data[].mockbooleanYes
data[].identifiersarray<enum>Yes
data[].lookalikebooleanYes
data[].batch_sizeintegerYes

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

GET/v1/apps/{appId}/ads/accountsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdAccountList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].platformenumYesValues: "meta", "google", "tiktok", "linkedin"
data[].external_idstringYes
data[].namestringYes
data[].currencystring | nullYes
data[].timezonestring | nullYes
data[].statusenumYesValues: "active", "error", "revoked"
data[].scopesarray<string>Yes
data[].login_customer_idstring | nullYes
data[].token_expires_atstring | nullYes
data[].last_refreshed_atstring | nullYes
data[].last_errorstring | nullYes
data[].last_error_atstring | nullYes
data[].terms_accepted_atstring | nullYes
data[].terms_versionstring | nullYes
data[].audiencesintegerYes
data[].created_atstringYes
data[].updated_atstringYes

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

GET/v1/apps/{appId}/ads/audiencesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
ad_account_idquerystringNoLength: 1–64"ada_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdAudienceList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].ad_account_idstringYes
data[].platformenumYesValues: "meta", "google", "tiktok", "linkedin"
data[].sourceenumYesValues: "segment", "journey", "lookalike"
data[].segment_idstring | nullYes
data[].segment_namestring | nullYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].external_idstring | nullYes
data[].statusenumYesValues: "pending", "active", "paused", "error"
data[].identifiersarray<enum>Yes
data[].sync_interval_minutesintegerYes
data[].next_sync_atstring | nullYes
data[].last_synced_atstring | nullYes
data[].last_sync_statusenum | nullYes
data[].full_reload_requestedbooleanYes
data[].member_countintegerYes
data[].estimated_sizeinteger | nullYes
data[].match_ratenumber | nullYes
data[].size_updated_atstring | nullYes
data[].lookalike_source_idstring | nullYes
data[].lookalike_specobject | nullYes
data[].consecutive_failuresintegerYes
data[].last_errorstring | nullYes
data[].last_error_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

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

POST/v1/apps/{appId}/ads/audiencesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateAdAudienceDto

FieldTypeRequiredDescription
ad_account_idstringYesLength: 1–64
sourceenumYesValues: "segment", "journey"
segment_idstringNoLength: 1–64
namestringYesLength: 1–120
descriptionstringNoLength: 0–500
identifiersarray<enum>NoItems: 1–3
sync_interval_minutesintegerNoRange: 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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
ad_account_idstringYes
platformenumYesValues: "meta", "google", "tiktok", "linkedin"
sourceenumYesValues: "segment", "journey", "lookalike"
segment_idstring | nullYes
segment_namestring | nullYes
namestringYes
descriptionstring | nullYes
external_idstring | nullYes
statusenumYesValues: "pending", "active", "paused", "error"
identifiersarray<enum>Yes
sync_interval_minutesintegerYes
next_sync_atstring | nullYes
last_synced_atstring | nullYes
last_sync_statusenum | nullYes
full_reload_requestedbooleanYes
member_countintegerYes
estimated_sizeinteger | nullYes
match_ratenumber | nullYes
size_updated_atstring | nullYes
lookalike_source_idstring | nullYes
lookalike_specobject | nullYes
consecutive_failuresintegerYes
last_errorstring | nullYes
last_error_atstring | nullYes
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/ads/audiences/{audienceId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
audienceIdpathstringYes"adu_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdAudience

FieldTypeRequiredDescription
idstringYes
app_idstringYes
ad_account_idstringYes
platformenumYesValues: "meta", "google", "tiktok", "linkedin"
sourceenumYesValues: "segment", "journey", "lookalike"
segment_idstring | nullYes
segment_namestring | nullYes
namestringYes
descriptionstring | nullYes
external_idstring | nullYes
statusenumYesValues: "pending", "active", "paused", "error"
identifiersarray<enum>Yes
sync_interval_minutesintegerYes
next_sync_atstring | nullYes
last_synced_atstring | nullYes
last_sync_statusenum | nullYes
full_reload_requestedbooleanYes
member_countintegerYes
estimated_sizeinteger | nullYes
match_ratenumber | nullYes
size_updated_atstring | nullYes
lookalike_source_idstring | nullYes
lookalike_specobject | nullYes
consecutive_failuresintegerYes
last_errorstring | nullYes
last_error_atstring | nullYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/ads/audiences/{audienceId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
audienceIdpathstringYes"adu_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateAdAudienceDto

FieldTypeRequiredDescription
namestringNoLength: 1–120
descriptionstring | nullNo
segment_idstringNoLength: 1–64
identifiersarray<enum>NoItems: 1–3
sync_interval_minutesintegerNoRange: 60–360
statusenumNoValues: "active", "paused"

Example:

{
  "name": "Sipariş bildirimleri",
  "status": "active",
  "description": "Sipariş durumu güncellemeleri",
  "segment_id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "identifiers": [
    "email"
  ]
}

Responses

200 — Success.

Schema: AdAudience

FieldTypeRequiredDescription
idstringYes
app_idstringYes
ad_account_idstringYes
platformenumYesValues: "meta", "google", "tiktok", "linkedin"
sourceenumYesValues: "segment", "journey", "lookalike"
segment_idstring | nullYes
segment_namestring | nullYes
namestringYes
descriptionstring | nullYes
external_idstring | nullYes
statusenumYesValues: "pending", "active", "paused", "error"
identifiersarray<enum>Yes
sync_interval_minutesintegerYes
next_sync_atstring | nullYes
last_synced_atstring | nullYes
last_sync_statusenum | nullYes
full_reload_requestedbooleanYes
member_countintegerYes
estimated_sizeinteger | nullYes
match_ratenumber | nullYes
size_updated_atstring | nullYes
lookalike_source_idstring | nullYes
lookalike_specobject | nullYes
consecutive_failuresintegerYes
last_errorstring | nullYes
last_error_atstring | nullYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/ads/audiences/{audienceId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
audienceIdpathstringYes"adu_01JD3W5Q7X9K2M4N6P8R0T1V3W"
delete_on_platformqueryenumNoValues: "true", "false""true"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdOk

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/ads/audiences/adu_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Run the sync now

POST/v1/apps/{appId}/ads/audiences/{audienceId}/syncTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
audienceIdpathstringYes"adu_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SyncAdAudienceDto

FieldTypeRequiredDescription
fullbooleanNo

Example:

{
  "full": true
}

Responses

202 — Success.

Schema: AdAudienceSyncQueued

FieldTypeRequiredDescription
queuedtrueYes
next_sync_atstringYes
modeenumYesValues: "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

GET/v1/apps/{appId}/ads/audiences/{audienceId}/syncsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
audienceIdpathstringYes"adu_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoRange: 1–10050
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdAudienceSyncList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].audience_idstringYes
data[].triggerenumYesValues: "schedule", "manual", "journey"
data[].modeenumYesValues: "incremental", "full"
data[].statusenumYesValues: "running", "succeeded", "partial", "failed"
data[].addedintegerYes
data[].removedintegerYes
data[].failedintegerYes
data[].skipped_no_consentintegerYes
data[].skipped_no_identifierintegerYes
data[].batchesintegerYes
data[].retriesintegerYes
data[].errorstring | nullYes
data[].started_atstringYes
data[].finished_atstring | nullYes
data[].duration_msinteger | nullYes

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

POST/v1/apps/{appId}/ads/audiences/{audienceId}/lookalikesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
audienceIdpathstringYes"adu_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateLookalikeDto

FieldTypeRequiredDescription
namestringNoLength: 1–120
countrystringYes
rationumberYesRange: 0.01–0.2

Example:

{
  "country": "TR",
  "ratio": 0.2,
  "name": "Sipariş bildirimleri"
}

Responses

201 — Success.

Schema: AdAudience

FieldTypeRequiredDescription
idstringYes
app_idstringYes
ad_account_idstringYes
platformenumYesValues: "meta", "google", "tiktok", "linkedin"
sourceenumYesValues: "segment", "journey", "lookalike"
segment_idstring | nullYes
segment_namestring | nullYes
namestringYes
descriptionstring | nullYes
external_idstring | nullYes
statusenumYesValues: "pending", "active", "paused", "error"
identifiersarray<enum>Yes
sync_interval_minutesintegerYes
next_sync_atstring | nullYes
last_synced_atstring | nullYes
last_sync_statusenum | nullYes
full_reload_requestedbooleanYes
member_countintegerYes
estimated_sizeinteger | nullYes
match_ratenumber | nullYes
size_updated_atstring | nullYes
lookalike_source_idstring | nullYes
lookalike_specobject | nullYes
consecutive_failuresintegerYes
last_errorstring | nullYes
last_error_atstring | nullYes
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/ads/campaignsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
ad_account_idquerystringNoLength: 1–64"ada_01JD3W5Q7X9K2M4N6P8R0T1V3W"
levelqueryenumNoValues: "campaign", "ad_set", "ad""campaign"
parent_idquerystringNoLength: 1–100"adu_01JD3W5Q7X9K2M4N6P8R0T1V3W"
statusqueryenumNoValues: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown""active"
qquerystringNoLength: 0–100"ayse"
fromquerystringNo"2026-10-01T00:00:00Z"
toquerystringNo"2026-10-17T00:00:00Z"
limitqueryintegerNoRange: 1–50050
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdEntityList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].ad_account_idstringYes
data[].platformenumYesValues: "meta", "google", "tiktok"
data[].levelenumYesValues: "campaign", "ad_set", "ad"
data[].external_idstringYes
data[].campaign_external_idstringYes
data[].ad_set_external_idstring | nullYes
data[].namestringYes
data[].statusenumYesValues: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown"
data[].platform_statusstring | nullYes
data[].objectivestring | nullYes
data[].optimization_goalstring | nullYes
data[].currencystring | nullYes
data[].daily_budgetstring | nullYes
data[].lifetime_budgetstring | nullYes
data[].start_atstring | nullYes
data[].end_atstring | nullYes
data[].audience_external_idsarray<string>Yes
data[].creativeobject | nullYes
data[].budget_editablebooleanYes
data[].created_by_pushizobooleanYes
data[].last_seen_atstring | nullYes
data[].platform_urlstringYes
data[].metricsobject | nullYes
data[].updated_atstringYes
fromstringYes
tostringYes
accountsarray<object>Yes
accounts[].idstringYes
accounts[].campaigns_synced_atstring | nullYes
accounts[].insights_synced_atstring | nullYes
accounts[].campaigns_sync_errorstring | nullYes
accounts[].insights_sync_errorstring | nullYes

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

POST/v1/apps/{appId}/ads/campaignsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateAdCampaignDto

FieldTypeRequiredDescription
ad_account_idstringYesLength: 1–64
audience_idstringYesLength: 1–64
namestringYesLength: 1–200
objectiveenumYesValues: "traffic", "conversions", "leads", "awareness"
optimization_goalenumNoValues: "clicks", "landing_page_views", "conversions", "reach", "impressions"
daily_budgetstring | numberYes
start_atstring (date-time)No
end_atstring (date-time)No
countriesarray<string>YesItems: 1–25
statusenumNoValues: "active", "paused"
pixel_idstringNoLength: 1–64
creativeobjectNo
creative.headlinestringYesLength: 1–30
creative.long_headlinestringNoLength: 1–90
creative.primary_textstringYesLength: 1–500
creative.descriptionstringNoLength: 1–90
creative.link_urlstring (uri)Yes
creative.call_to_actionenumYesValues: "LEARN_MORE", "SHOP_NOW", "SIGN_UP", "SUBSCRIBE", "DOWNLOAD", "CONTACT_US", "BOOK_NOW", "GET_OFFER"
creative.image_idstringNoLength: 1–64
creative.square_image_idstringNoLength: 1–64
creative.page_idstringNoLength: 1–64
creative.business_namestringNoLength: 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

FieldTypeRequiredDescription
campaignobjectYes
campaign.idstringYes
campaign.app_idstringYes
campaign.ad_account_idstringYes
campaign.platformenumYesValues: "meta", "google", "tiktok"
campaign.levelenumYesValues: "campaign", "ad_set", "ad"
campaign.external_idstringYes
campaign.campaign_external_idstringYes
campaign.ad_set_external_idstring | nullYes
campaign.namestringYes
campaign.statusenumYesValues: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown"
campaign.platform_statusstring | nullYes
campaign.objectivestring | nullYes
campaign.optimization_goalstring | nullYes
campaign.currencystring | nullYes
campaign.daily_budgetstring | nullYes
campaign.lifetime_budgetstring | nullYes
campaign.start_atstring | nullYes
campaign.end_atstring | nullYes
campaign.audience_external_idsarray<string>Yes
campaign.creativeobject | nullYes
campaign.budget_editablebooleanYes
campaign.created_by_pushizobooleanYes
campaign.last_seen_atstring | nullYes
campaign.platform_urlstringYes
campaign.metricsobject | nullYes
campaign.updated_atstringYes
ad_set_idstringYes
ad_idstring | nullYes
warningsarray<string>Yes
platform_urlstringYes

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

GET/v1/apps/{appId}/ads/campaigns/{entityId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
entityIdpathstringYes"ade_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdEntity

FieldTypeRequiredDescription
idstringYes
app_idstringYes
ad_account_idstringYes
platformenumYesValues: "meta", "google", "tiktok"
levelenumYesValues: "campaign", "ad_set", "ad"
external_idstringYes
campaign_external_idstringYes
ad_set_external_idstring | nullYes
namestringYes
statusenumYesValues: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown"
platform_statusstring | nullYes
objectivestring | nullYes
optimization_goalstring | nullYes
currencystring | nullYes
daily_budgetstring | nullYes
lifetime_budgetstring | nullYes
start_atstring | nullYes
end_atstring | nullYes
audience_external_idsarray<string>Yes
creativeobject | nullYes
budget_editablebooleanYes
created_by_pushizobooleanYes
last_seen_atstring | nullYes
platform_urlstringYes
metricsobject | nullYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/ads/campaigns/{entityId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
entityIdpathstringYes"ade_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateAdCampaignDto

FieldTypeRequiredDescription
statusenumNoValues: "active", "paused"
daily_budgetstring | numberNo

Example:

{
  "status": "active",
  "daily_budget": "değer"
}

Responses

200 — Success.

Schema: AdEntity

FieldTypeRequiredDescription
idstringYes
app_idstringYes
ad_account_idstringYes
platformenumYesValues: "meta", "google", "tiktok"
levelenumYesValues: "campaign", "ad_set", "ad"
external_idstringYes
campaign_external_idstringYes
ad_set_external_idstring | nullYes
namestringYes
statusenumYesValues: "active", "paused", "pending", "rejected", "archived", "deleted", "unknown"
platform_statusstring | nullYes
objectivestring | nullYes
optimization_goalstring | nullYes
currencystring | nullYes
daily_budgetstring | nullYes
lifetime_budgetstring | nullYes
start_atstring | nullYes
end_atstring | nullYes
audience_external_idsarray<string>Yes
creativeobject | nullYes
budget_editablebooleanYes
created_by_pushizobooleanYes
last_seen_atstring | nullYes
platform_urlstringYes
metricsobject | nullYes
updated_atstringYes

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)

GET/v1/apps/{appId}/ads/campaigns/{entityId}/previewTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
entityIdpathstringYes"ade_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdCampaignPreview

FieldTypeRequiredDescription
preview_urlstring | nullYes
platform_urlstringYes
creativeobject | nullYes

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

GET/v1/apps/{appId}/ads/accounts/{accountId}/pagesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
accountIdpathstringYes"ada_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdPageList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes

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

GET/v1/apps/{appId}/ads/creativesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.
FieldTypeRequiredDescription
dataarray<AdCreative>No
data[].idstringYes
data[].file_namestring | nullYes
data[].content_typestringYes
data[].bytesintegerYes
data[].widthinteger | nullYes
data[].heightinteger | nullYes
data[].preview_urlstringYes
data[].created_atstringYes

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)

POST/v1/apps/{appId}/ads/creativesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

201 — Success.

Schema: AdCreative

FieldTypeRequiredDescription
idstringYes
file_namestring | nullYes
content_typestringYes
bytesintegerYes
widthinteger | nullYes
heightinteger | nullYes
preview_urlstringYes
created_atstringYes

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)

GET/v1/apps/{appId}/ads/settingsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdReportingSettings

FieldTypeRequiredDescription
reporting_currencystringYes
attribution_modelenumYesValues: "last_click", "first_click", "linear", "time_decay"
window_daysintegerYes
half_life_daysintegerYes
conversion_eventsarray<string>Yes
effective_conversion_eventsarray<string>Yes
fxobjectYes
fx.latest_daystring | nullYes
fx.sourcestring | nullYes

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

PUT/v1/apps/{appId}/ads/settingsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: AdReportingSettingsInputDto

FieldTypeRequiredDescription
reporting_currencystringNo
attribution_modelenumNoValues: "last_click", "first_click", "linear", "time_decay"
window_daysintegerNoRange: 1–90
half_life_daysintegerNoRange: 1–30
conversion_eventsarray<string>NoItems: 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

FieldTypeRequiredDescription
reporting_currencystringYes
attribution_modelenumYesValues: "last_click", "first_click", "linear", "time_decay"
window_daysintegerYes
half_life_daysintegerYes
conversion_eventsarray<string>Yes
effective_conversion_eventsarray<string>Yes
fxobjectYes
fx.latest_daystring | nullYes
fx.sourcestring | nullYes

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

POST/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

NameInTypeRequiredDescriptionExample
configIdpathstringYes"cac_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdCapiTestResult

FieldTypeRequiredDescription
oktrueYes
responsemap<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

POST/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

NameInTypeRequiredDescriptionExample
deliveryIdpathstringYes"dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdCapiDelivery

FieldTypeRequiredDescription
idstringYes
config_idstringYes
platformenumYesValues: "meta", "google", "tiktok"
event_idstringYes
event_namestringYes
platform_eventstringYes
dedup_idstringYes
user_idstring | nullYes
valuenumber | nullYes
currencystring | nullYes
statusenumYesValues: "pending", "sent", "failed", "skipped"
skip_reasonstring | nullYes
attemptsintegerYes
next_attempt_atstring | nullYes
last_errorstring | nullYes
testbooleanYes
event_occurred_atstringYes
sent_atstring | nullYes
created_atstringYes

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

POST/v1/apps/{appId}/ads/accounts/{accountId}/refreshTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
accountIdpathstringYes"ada_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

202 — Success.

Schema: AdRefreshQueued

FieldTypeRequiredDescription
queuedtrueYes
next_sync_atstringYes

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

GET/v1/apps/{appId}/ads/reports/spendTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
fromquerystringYes"2026-10-01T00:00:00Z"
toquerystringYes"2026-10-17T00:00:00Z"
currencyquerystringNo"TRY"
group_byqueryenumNoValues: "day", "platform", "account", "campaign", "ad_set""day"
ad_account_idquerystringNoLength: 1–64"ada_01JD3W5Q7X9K2M4N6P8R0T1V3W"
campaign_idquerystringNoLength: 1–100"ade_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdSpendReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
currencystringYes
group_bystringYes
rowsarray<object>Yes
rows[].keystringYes
rows[].labelstringYes
rows[].platformstring | nullYes
rows[].impressionsnumberYes
rows[].clicksnumberYes
rows[].spendnumberYes
rows[].conversionsnumberYes
rows[].conversion_valuenumberYes
rows[].ctrnumber | nullYes
rows[].cpcnumber | nullYes
rows[].cpanumber | nullYes
rows[].roasnumber | nullYes
totalsobjectYes
totals.impressionsnumberYes
totals.clicksnumberYes
totals.spendnumberYes
totals.conversionsnumberYes
totals.conversion_valuenumberYes
totals.ctrnumber | nullYes
totals.cpcnumber | nullYes
totals.cpanumber | nullYes
totals.roasnumber | nullYes
fx_missingarray<string>Yes
storeenumYesValues: "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)

GET/v1/apps/{appId}/ads/reports/attributionTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
fromquerystringYes"2026-10-01T00:00:00Z"
toquerystringYes"2026-10-17T00:00:00Z"
modelqueryenumNoValues: "last_click", "first_click", "linear", "time_decay""last_click"
window_daysqueryintegerNoRange: 1–901
half_life_daysqueryintegerNoRange: 1–301
currencyquerystringNo"TRY"
group_byqueryenumNoValues: "channel", "campaign", "ad_set""channel"
conversion_eventsquerystringNoLength: 0–1000"örnek"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdAttributionReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
modelenumYesValues: "last_click", "first_click", "linear", "time_decay"
window_daysintegerYes
half_life_daysintegerYes
currencystringYes
group_bystringYes
conversion_eventsarray<string>Yes
rowsarray<object>Yes
rows[].keystringYes
rows[].channelenumYesValues: "meta", "google", "tiktok", "linkedin", "microsoft", "other_paid", "utm", "push", "email", "sms", "whatsapp", "rcs", "direct"
rows[].labelstringYes
rows[].paidbooleanYes
rows[].conversionsnumberYes
rows[].revenuenumberYes
rows[].new_customersnumberYes
rows[].spendnumber | nullYes
rows[].roasnumber | nullYes
rows[].cacnumber | nullYes
totalsobjectYes
totals.conversionsnumberYes
totals.revenuenumberYes
totals.spendnumberYes
totals.new_customersnumberYes
totals.roasnumber | nullYes
totals.platform_roasnumber | nullYes
totals.cacnumber | nullYes
totals.paid_cacnumber | nullYes
truncatedbooleanYes
fx_missingarray<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

GET/v1/apps/{appId}/ads/reports/ltvTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
monthsqueryintegerNoRange: 1–241
cohortsqueryintegerNoRange: 1–121
currencyquerystringNo"TRY"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdLtvReport

FieldTypeRequiredDescription
currencystringYes
monthsintegerYes
conversion_eventsarray<string>Yes
cohortsarray<object>Yes
cohorts[].cohortstringYes
cohorts[].sizeintegerYes
cohorts[].revenuearray<number>Yes
cohorts[].ltvarray<number>Yes
averagearray<number | null>Yes
fx_missingarray<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

GET/v1/apps/{appId}/ads/conversions-api/configsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdCapiConfigList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].platformenumYesValues: "meta", "google", "tiktok"
data[].namestringYes
data[].ad_account_idstring | nullYes
data[].enabledbooleanYes
data[].settingsobjectYes
data[].settings.pixel_idstring | nullYes
data[].settings.customer_idstring | nullYes
data[].settings.login_customer_idstring | nullYes
data[].settings.pixel_codestring | nullYes
data[].event_mappingsarray<object>Yes
data[].event_mappings[].event_namestringYes
data[].event_mappings[].platform_eventstringYes
data[].event_mappings[].value_propertystring | nullYes
data[].event_mappings[].currency_propertystring | nullYes
data[].test_event_codestring | nullYes
data[].test_modebooleanYes
data[].action_sourceenumYesValues: "website", "app"
data[].default_currencystringYes
data[].has_access_tokenbooleanYes
data[].last_sent_atstring | nullYes
data[].last_errorstring | nullYes
data[].last_error_atstring | nullYes
data[].statsobjectYes
data[].stats.pendingintegerYes
data[].stats.sentintegerYes
data[].stats.failedintegerYes
data[].stats.skippedintegerYes
data[].created_atstringYes
data[].updated_atstringYes

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

GET/v1/apps/{appId}/ads/conversions-api/deliveriesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
config_idquerystringNoLength: 1–64"cac_01JD3W5Q7X9K2M4N6P8R0T1V3W"
statusqueryenumNoValues: "pending", "sent", "failed", "skipped""pending"
limitqueryintegerNoRange: 1–20050
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdCapiDeliveryList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].config_idstringYes
data[].platformenumYesValues: "meta", "google", "tiktok"
data[].event_idstringYes
data[].event_namestringYes
data[].platform_eventstringYes
data[].dedup_idstringYes
data[].user_idstring | nullYes
data[].valuenumber | nullYes
data[].currencystring | nullYes
data[].statusenumYesValues: "pending", "sent", "failed", "skipped"
data[].skip_reasonstring | nullYes
data[].attemptsintegerYes
data[].next_attempt_atstring | nullYes
data[].last_errorstring | nullYes
data[].testbooleanYes
data[].event_occurred_atstringYes
data[].sent_atstring | nullYes
data[].created_atstringYes

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

GET/v1/apps/{appId}/ads/alert-rulesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdBudgetAlertRuleList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].kindenumYesValues: "daily_spend", "roas_drop", "budget_depletion"
data[].ad_account_idstring | nullYes
data[].campaign_external_idstring | nullYes
data[].thresholdnumberYes
data[].window_daysintegerYes
data[].recipientsarray<string>Yes
data[].enabledbooleanYes
data[].last_valuenumber | nullYes
data[].last_evaluated_atstring | nullYes
data[].last_triggered_onstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

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

POST/v1/apps/{appId}/ads/alert-rulesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateBudgetAlertRuleDto

FieldTypeRequiredDescription
namestringYesLength: 1–120
kindenumYesValues: "daily_spend", "roas_drop", "budget_depletion"
ad_account_idstring | nullNo
campaign_external_idstring | nullNo
thresholdnumberYesRange: −∞–1000000000000
window_daysintegerNoRange: 1–30
recipientsarray<string (email)>NoItems: 0–20
enabledbooleanNo

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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
kindenumYesValues: "daily_spend", "roas_drop", "budget_depletion"
ad_account_idstring | nullYes
campaign_external_idstring | nullYes
thresholdnumberYes
window_daysintegerYes
recipientsarray<string>Yes
enabledbooleanYes
last_valuenumber | nullYes
last_evaluated_atstring | nullYes
last_triggered_onstring | nullYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/ads/alert-rules/{ruleId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
ruleIdpathstringYes"bar_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateBudgetAlertRuleDto

FieldTypeRequiredDescription
namestringNoLength: 1–120
ad_account_idstring | nullNo
campaign_external_idstring | nullNo
thresholdnumberNoRange: −∞–1000000000000
window_daysintegerNoRange: 1–30
recipientsarray<string (email)>NoItems: 0–20
enabledbooleanNo

Example:

{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "ad_account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "campaign_external_id": "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "threshold": 1.5
}

Responses

200 — Success.

Schema: AdBudgetAlertRule

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
kindenumYesValues: "daily_spend", "roas_drop", "budget_depletion"
ad_account_idstring | nullYes
campaign_external_idstring | nullYes
thresholdnumberYes
window_daysintegerYes
recipientsarray<string>Yes
enabledbooleanYes
last_valuenumber | nullYes
last_evaluated_atstring | nullYes
last_triggered_onstring | nullYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/ads/alert-rules/{ruleId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
ruleIdpathstringYes"bar_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdOk

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/ads/alert-rules/bar_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Triggered budget alerts

GET/v1/apps/{appId}/ads/alertsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
rule_idquerystringNoLength: 1–64"bar_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoRange: 1–20050
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AdBudgetAlertList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].rule_idstringYes
data[].rule_namestringYes
data[].kindenumYesValues: "daily_spend", "roas_drop", "budget_depletion"
data[].daystringYes
data[].valuenumberYes
data[].thresholdnumberYes
data[].detailsmap<string, any>Yes
data[].emailedintegerYes
data[].created_atstringYes

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"

On this page

OperationsDetailsAd platforms (enabled/mock, identifiers, lookalike support)200 — Success.Connected ad accounts200 — Success.Ad audiences200 — Success.Create an ad audience201 — Success.Ad audience details200 — Success.Update an ad audience200 — Success.Delete an ad audience200 — Success.Run the sync now202 — Success.Sync history200 — Success.Create a lookalike audience201 — Success.Campaign / ad set / ad list and metrics200 — Success.Create an ad campaign: campaign + ad set (Pushizo audience) + creative/ad201 — Success.Campaign / ad set / ad details200 — Success.Change status and daily budget200 — Success.Creative preview (platform preview link + creative summary)200 — Success.Meta: Facebook pages the account can promote200 — Success.Uploaded creative images200 — Success.Upload a creative image (multipart file: PNG/JPEG, up to 5 MB)201 — Success.Reporting currency (organization) and attribution defaults (app)200 — Success.Update the reporting currency and attribution defaults200 — Success.Send a synthetic test event to the platform's test tool200 — Success.Retry a failed delivery200 — Success.Refresh campaigns and metrics now202 — Success.Spend and performance report200 — Success.Unified attribution report (ROAS, CAC)200 — Success.Cohort LTV report200 — Success.Conversions API configurations200 — Success.Conversions API delivery history200 — Success.Budget alert rules200 — Success.Create a budget alert rule201 — Success.Update a budget alert rule200 — Success.Delete a budget alert rule200 — Success.Triggered budget alerts200 — Success.