Analytics
Analytics — 54 operations (GET /v1/apps/{appId}/rfm/config, PUT /v1/apps/{appId}/rfm/config, POST /v1/apps/{appId}/rfm/compute, …). Generated from the OpenAPI 3.1.0 contract.
Delivery, subscription, event, conversion, funnel, provider health, engagement and retention reports (date range, comparison).
Base URL: https://api.pushizo.com · Tag: analytics · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/rfm/config | RFM model |
PUT | /v1/apps/{appId}/rfm/config | Configure the RFM model |
POST | /v1/apps/{appId}/rfm/compute | Recompute scores |
GET | /v1/apps/{appId}/rfm/overview | Segment distribution |
GET | /v1/apps/{appId}/rfm/transitions | Segment transitions between two dates |
GET | /v1/apps/{appId}/rfm/users | Users with a score |
GET | /v1/apps/{appId}/affinity/config | Interest model |
PUT | /v1/apps/{appId}/affinity/config | Configure the interest model |
POST | /v1/apps/{appId}/affinity/compute | Recompute interests |
GET | /v1/apps/{appId}/affinity/overview | Most common interests per attribute |
GET | /v1/apps/{appId}/affinity/users/{userId} | The contact's interests and weekly frequency cap |
GET | /v1/apps/{appId}/channel-scores/config | Channel score settings |
PUT | /v1/apps/{appId}/channel-scores/config | Configure channel scores |
POST | /v1/apps/{appId}/channel-scores/compute | Recompute channel scores |
GET | /v1/apps/{appId}/channel-scores/overview | Best channel distribution |
GET | /v1/apps/{appId}/channel-scores/users | Users with a known best channel |
GET | /v1/apps/{appId}/channel-scores/users/{userId} | The user's channel scores |
GET | /v1/apps/{appId}/predictions | Predictive models |
POST | /v1/apps/{appId}/predictions | Create a predictive model |
GET | /v1/apps/{appId}/predictions/{id} | Predictive model |
PATCH | /v1/apps/{appId}/predictions/{id} | Update a predictive model |
DELETE | /v1/apps/{appId}/predictions/{id} | Delete a predictive model |
POST | /v1/apps/{appId}/predictions/{id}/compute | Retrain the model |
GET | /v1/apps/{appId}/predictions/{id}/users | Users with a score |
GET | /v1/apps/{appId}/decision-agents | Decision agents |
POST | /v1/apps/{appId}/decision-agents | Create a decision agent |
GET | /v1/apps/{appId}/decision-agents/{id} | Decision agent |
PATCH | /v1/apps/{appId}/decision-agents/{id} | Update a decision agent |
DELETE | /v1/apps/{appId}/decision-agents/{id} | Delete a decision agent |
GET | /v1/apps/{appId}/decision-agents/{id}/report | Uplift report |
POST | /v1/apps/{appId}/decision-agents/{id}/decide | Make a decision for a user |
GET | /v1/apps/{appId}/analytics/sessions | Session volume and unique users for the last 14 days (daily totals) |
GET | /v1/apps/{appId}/analytics/overview | Overview KPIs |
GET | /v1/apps/{appId}/analytics/messages | Delivery report |
GET | /v1/apps/{appId}/analytics/subscriptions | Subscription growth |
GET | /v1/apps/{appId}/analytics/uninstalls | App uninstall report |
GET | /v1/apps/{appId}/analytics/android-delivery | Android delivery health report |
GET | /v1/apps/{appId}/analytics/events | Event volume |
GET | /v1/apps/{appId}/analytics/conversions | Conversion/attribution |
POST | /v1/apps/{appId}/analytics/reports/run | Run a report |
POST | /v1/apps/{appId}/analytics/paths | Path analysis |
POST | /v1/apps/{appId}/analytics/funnels | Funnel |
GET | /v1/apps/{appId}/analytics/providers | Provider health |
GET | /v1/apps/{appId}/analytics/retention | Retention cohort |
GET | /v1/apps/{appId}/analytics/engagement | Engagement heatmap |
GET | /v1/apps/{appId}/global-control | Global control group settings |
PUT | /v1/apps/{appId}/global-control | Configure the global control group |
POST | /v1/apps/{appId}/global-control/reset | Rebuild the group (membership changes, measurement restarts) |
GET | /v1/apps/{appId}/global-control/report | Conversion comparison between the control group and the group receiving messages |
GET | /v1/apps/{appId}/analytics/reports | Saved reports |
POST | /v1/apps/{appId}/analytics/reports | Save a report |
GET | /v1/apps/{appId}/analytics/reports/{id} | Saved report |
PATCH | /v1/apps/{appId}/analytics/reports/{id} | Update a report |
DELETE | /v1/apps/{appId}/analytics/reports/{id} | Delete a report |
Details
RFM model
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: RfmConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
event_names | array<string> | Yes | |
value_property | string | null | Yes | |
use_monetary | boolean | Yes | |
window_days | integer | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
first_computed_at | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes |
Example response:
{
"enabled": true,
"status": "idle",
"configured": true,
"event_names": [
"purchase"
],
"value_property": "örnek",
"use_monetary": true,
"window_days": 1,
"last_error": "örnek",
"first_computed_at": "örnek",
"last_computed_at": "örnek",
"scored_users": 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/rfm/config" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Configure the RFM model
If the model is enabled, scores are recomputed after saving.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateRfmConfigDto
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
event_names | array<string> | Yes | Items: 1–10 |
value_property | string | null | No | |
use_monetary | boolean | No | |
window_days | integer | No | Range: 30–730 |
Example:
{
"enabled": true,
"event_names": [
"purchase"
],
"value_property": "değer",
"use_monetary": true,
"window_days": 30
}Responses
200 — Success.
Schema: RfmConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
event_names | array<string> | Yes | |
value_property | string | null | Yes | |
use_monetary | boolean | Yes | |
window_days | integer | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
first_computed_at | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes |
Example response:
{
"enabled": true,
"status": "idle",
"configured": true,
"event_names": [
"purchase"
],
"value_property": "örnek",
"use_monetary": true,
"window_days": 1,
"last_error": "örnek",
"first_computed_at": "örnek",
"last_computed_at": "örnek",
"scored_users": 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 PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/rfm/config" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"enabled": true,
"event_names": [
"purchase"
],
"value_property": "değer",
"use_monetary": true,
"window_days": 30
}'Recompute scores
The job is queued; track progress via the status field.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
202 — Success.
Schema: RfmConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
event_names | array<string> | Yes | |
value_property | string | null | Yes | |
use_monetary | boolean | Yes | |
window_days | integer | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
first_computed_at | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes |
Example response:
{
"enabled": true,
"status": "idle",
"configured": true,
"event_names": [
"purchase"
],
"value_property": "örnek",
"use_monetary": true,
"window_days": 1,
"last_error": "örnek",
"first_computed_at": "örnek",
"last_computed_at": "örnek",
"scored_users": 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 POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/rfm/compute" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Segment distribution
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: RfmOverview
| Field | Type | Required | Description |
|---|---|---|---|
total | integer | Yes | |
low_population | boolean | Yes | |
last_computed_at | string | null | Yes | |
segments | array<object> | Yes | |
segments[].segment | enum | Yes | Values: "champions", "loyal", "potential", "new", "promising", "need_attention", "about_to_sleep", "at_risk", "cant_lose", "hibernating", "lost" |
segments[].users | integer | Yes | |
segments[].share | number | Yes | |
segments[].avg_recency_days | number | null | Yes | |
segments[].avg_frequency | number | null | Yes | |
segments[].avg_monetary | number | null | Yes |
Example response:
{
"total": 1,
"low_population": true,
"last_computed_at": "örnek",
"segments": [
{
"segment": "champions",
"users": 1,
"share": 1.5,
"avg_recency_days": 1.5,
"avg_frequency": 1.5,
"avg_monetary": 1.5
}
]
}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/rfm/overview" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Segment transitions between two dates
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
from | query | string | No | "2026-10-01T00:00:00Z" | |
to | query | string | No | "2026-10-17T00:00:00Z" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: RfmTransitions
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
first_computed_at | string | null | Yes | |
transitions | array<object> | Yes | |
transitions[].from | enum | null | Yes | |
transitions[].to | enum | null | Yes | |
transitions[].users | integer | Yes |
Example response:
{
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"first_computed_at": "örnek",
"transitions": [
{
"from": "champions",
"to": "champions",
"users": 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/rfm/transitions" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Users with a score
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
segment | query | enum | No | Values: "champions", "loyal", "potential", "new", "promising", "need_attention", "about_to_sleep", "at_risk", "cant_lose", "hibernating", "lost" | "champions" |
limit | query | integer | No | Range: 1–200 | 50 |
cursor | query | string | No | Length: 0–64 | "eyJpZCI6Im1zZ18wMUpE…" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: RfmUsersPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].user_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].segment | enum | Yes | Values: "champions", "loyal", "potential", "new", "promising", "need_attention", "about_to_sleep", "at_risk", "cant_lose", "hibernating", "lost" |
data[].r | integer | Yes | |
data[].f | integer | Yes | |
data[].m | integer | null | Yes | |
data[].recency_days | integer | Yes | |
data[].frequency | integer | Yes | |
data[].monetary | number | Yes | |
data[].last_event_at | string | Yes | |
data[].segment_since | string | Yes | |
next_cursor | string | null | Yes |
Example response:
{
"data": [
{
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"segment": "champions",
"r": 1,
"f": 1,
"m": 1,
"recency_days": 1,
"frequency": 1,
"monetary": 1.5,
"last_event_at": "örnek",
"segment_since": "örnek"
}
],
"next_cursor": "eyJpZCI6Im1zZ18wMUpE…"
}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/rfm/users?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Interest model
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: AffinityConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
attributes | array<string> | Yes | |
events | map<string, number> | Yes | |
window_days | integer | Yes | |
half_life_days | integer | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes |
Example response:
{
"events": {
"key": 149.9
},
"enabled": true,
"status": "idle",
"configured": true,
"attributes": [
"örnek"
],
"window_days": 1,
"half_life_days": 1,
"last_error": "örnek",
"last_computed_at": "örnek",
"scored_users": 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/affinity/config" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Configure the interest model
If the model is enabled, interests are recomputed after saving.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateAffinityConfigDto
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
attributes | array<string> | Yes | Items: 1–5 |
events | map<string, number> | Yes | |
window_days | integer | No | Range: 7–365 |
half_life_days | integer | No | Range: 1–180 |
Example:
{
"events": {
"key": 149.9
},
"enabled": true,
"attributes": [
"değer"
],
"window_days": 7,
"half_life_days": 1
}Responses
200 — Success.
Schema: AffinityConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
attributes | array<string> | Yes | |
events | map<string, number> | Yes | |
window_days | integer | Yes | |
half_life_days | integer | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes |
Example response:
{
"events": {
"key": 149.9
},
"enabled": true,
"status": "idle",
"configured": true,
"attributes": [
"örnek"
],
"window_days": 1,
"half_life_days": 1,
"last_error": "örnek",
"last_computed_at": "örnek",
"scored_users": 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 PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/affinity/config" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"events": {
"key": 149.9
},
"enabled": true,
"attributes": [
"değer"
],
"window_days": 7,
"half_life_days": 1
}'Recompute interests
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
202 — Success.
Schema: AffinityConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
attributes | array<string> | Yes | |
events | map<string, number> | Yes | |
window_days | integer | Yes | |
half_life_days | integer | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes |
Example response:
{
"events": {
"key": 149.9
},
"enabled": true,
"status": "idle",
"configured": true,
"attributes": [
"örnek"
],
"window_days": 1,
"half_life_days": 1,
"last_error": "örnek",
"last_computed_at": "örnek",
"scored_users": 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 POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/affinity/compute" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Most common interests per attribute
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: AffinityOverview
| Field | Type | Required | Description |
|---|---|---|---|
last_computed_at | string | null | Yes | |
scored_users | integer | Yes | |
attributes | array<object> | Yes | |
attributes[].attribute | string | Yes | |
attributes[].values | array<object> | Yes | |
attributes[].values[].value | string | Yes | |
attributes[].values[].users | integer | Yes | |
attributes[].values[].top_users | integer | Yes |
Example response:
{
"last_computed_at": "örnek",
"scored_users": 1,
"attributes": [
{
"attribute": "örnek",
"values": [
{
"value": "user_42",
"users": 1,
"top_users": 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/affinity/overview" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"The contact's interests and weekly frequency cap
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
userId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: UserAffinity
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | |
affinities | array<object> | Yes | |
affinities[].attribute | string | Yes | |
affinities[].value | string | Yes | |
affinities[].score | number | Yes | |
affinities[].rank | integer | Yes | |
weekly_cap | integer | null | Yes | |
engagement | number | null | Yes | |
computed_at | string | null | Yes |
Example response:
{
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"affinities": [
{
"attribute": "örnek",
"value": "user_42",
"score": 1.5,
"rank": 1
}
],
"weekly_cap": 1,
"engagement": 1.5,
"computed_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/affinity/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Channel score settings
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: ChannelScoreConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
window_days | integer | Yes | |
min_sends | integer | Yes | |
count_email_opens | boolean | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes |
Example response:
{
"enabled": true,
"status": "idle",
"configured": true,
"window_days": 1,
"min_sends": 1,
"count_email_opens": true,
"last_error": "örnek",
"last_computed_at": "örnek",
"scored_users": 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/channel-scores/config" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Configure channel scores
When enabled, scores are recomputed after saving; disabling deletes them.
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: UpdateChannelScoreConfigDto
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
window_days | integer | No | Range: 7–365 |
min_sends | integer | No | Range: 1–100 |
count_email_opens | boolean | No |
Example:
{
"enabled": true,
"window_days": 7,
"min_sends": 1,
"count_email_opens": true
}Responses
200 — Success.
Schema: ChannelScoreConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
window_days | integer | Yes | |
min_sends | integer | Yes | |
count_email_opens | boolean | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes |
Example response:
{
"enabled": true,
"status": "idle",
"configured": true,
"window_days": 1,
"min_sends": 1,
"count_email_opens": true,
"last_error": "örnek",
"last_computed_at": "örnek",
"scored_users": 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 PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/channel-scores/config" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"enabled": true,
"window_days": 7,
"min_sends": 1,
"count_email_opens": true
}'Recompute channel scores
The job is queued; track progress via the status field.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
202 — Success.
Schema: ChannelScoreConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
window_days | integer | Yes | |
min_sends | integer | Yes | |
count_email_opens | boolean | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes |
Example response:
{
"enabled": true,
"status": "idle",
"configured": true,
"window_days": 1,
"min_sends": 1,
"count_email_opens": true,
"last_error": "örnek",
"last_computed_at": "örnek",
"scored_users": 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 POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/channel-scores/compute" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Best channel distribution
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: ChannelScoreOverview
| Field | Type | Required | Description |
|---|---|---|---|
total | integer | Yes | |
low_population | boolean | Yes | |
last_computed_at | string | null | Yes | |
channels | array<object> | Yes | |
channels[].channel | enum | Yes | Values: "push", "email", "whatsapp", "rcs", "sms" |
channels[].best_users | integer | Yes | |
channels[].share | number | Yes | |
channels[].sends | integer | Yes | |
channels[].engaged | integer | Yes | |
channels[].engagement_rate | number | null | Yes |
Example response:
{
"channels": [
"web_push"
],
"total": 1,
"low_population": true,
"last_computed_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/channel-scores/overview" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Users with a known best channel
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
channel | query | enum | No | Values: "push", "email", "whatsapp", "rcs", "sms" | "push" |
limit | query | integer | No | Range: 1–200 | 50 |
cursor | query | string | No | Length: 0–64 | "eyJpZCI6Im1zZ18wMUpE…" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ChannelScoreUsersPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].user_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].best_channel | enum | null | Yes | |
data[].scores | array<object> | Yes | |
data[].scores[].channel | enum | Yes | Values: "push", "email", "whatsapp", "rcs", "sms" |
data[].scores[].sends | integer | Yes | |
data[].scores[].engaged | integer | Yes | |
data[].scores[].score | number | Yes | |
next_cursor | string | null | Yes |
Example response:
{
"data": [
{
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"best_channel": "push",
"scores": [
{
"channel": "push",
"sends": 1,
"engaged": 1,
"score": 1.5
}
]
}
],
"next_cursor": "eyJpZCI6Im1zZ18wMUpE…"
}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/channel-scores/users?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"The user's channel scores
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
userId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ChannelScoreUser
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | |
external_id | string | null | Yes | |
best_channel | enum | null | Yes | |
scores | array<object> | Yes | |
scores[].channel | enum | Yes | Values: "push", "email", "whatsapp", "rcs", "sms" |
scores[].sends | integer | Yes | |
scores[].engaged | integer | Yes | |
scores[].score | number | Yes |
Example response:
{
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"best_channel": "push",
"scores": [
{
"channel": "push",
"sends": 1,
"engaged": 1,
"score": 1.5
}
]
}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/channel-scores/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Predictive models
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: PredictionModelList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].slug | string | Yes | |
data[].name | string | Yes | |
data[].kind | enum | Yes | Values: "churn", "event" |
data[].event_names | array<string> | Yes | |
data[].horizon_days | integer | Yes | |
data[].enabled | boolean | Yes | |
data[].status | enum | Yes | Values: "idle", "queued", "running", "failed" |
data[].outcome | enum | null | Yes | |
data[].last_computed_at | string | null | Yes | |
data[].scored_users | integer | Yes | |
data[].metrics | object | null | Yes | |
data[].distribution | array<object> | Yes | |
data[].distribution[].bucket | enum | Yes | Values: "low", "medium", "high" |
data[].distribution[].users | integer | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"enabled": true,
"status": "idle",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"kind": "churn",
"event_names": [
"purchase"
],
"horizon_days": 1,
"outcome": "ready",
"last_computed_at": "örnek",
"scored_users": 1,
"metrics": {
"auc": 1.5,
"base_rate": 1.5,
"train_users": 1,
"holdout_users": 1,
"positives": 1,
"negatives": 1,
"calibration": [
{}
],
"importance": [
{}
]
},
"distribution": [
{
"bucket": "low",
"users": 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/predictions" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a predictive model
Training is queued; track the result via the outcome field.
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: CreatePredictionDto
| Field | Type | Required | Description |
|---|---|---|---|
slug | string | Yes | |
name | string | Yes | Length: 1–100 |
kind | enum | Yes | Values: "churn", "event" |
event_names | array<string> | No | Default: []; Items: 0–10 |
horizon_days | integer | No | Default: 30; Range: 7–90 |
Example:
{
"name": "Sipariş bildirimleri",
"slug": "magaza",
"kind": "churn",
"event_names": [],
"horizon_days": 30
}Responses
201 — Success.
Schema: PredictionModel
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
slug | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "churn", "event" |
event_names | array<string> | Yes | |
horizon_days | integer | Yes | |
enabled | boolean | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
outcome | enum | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes | |
metrics | object | null | Yes | |
distribution | array<object> | Yes | |
distribution[].bucket | enum | Yes | Values: "low", "medium", "high" |
distribution[].users | integer | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"status": "idle",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"kind": "churn",
"event_names": [
"purchase"
],
"horizon_days": 1,
"outcome": "ready",
"last_computed_at": "örnek",
"scored_users": 1,
"metrics": {
"auc": 1.5,
"base_rate": 1.5,
"train_users": 1,
"holdout_users": 1,
"positives": 1,
"negatives": 1,
"calibration": [
{
"bucket": "low",
"users": 1,
"predicted": 1.5,
"actual": 1.5
}
],
"importance": [
{
"feature": "recency_days",
"weight": 1.5
}
]
},
"distribution": [
{
"bucket": "low",
"users": 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 POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/predictions" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"slug": "magaza",
"kind": "churn",
"event_names": [],
"horizon_days": 30
}'Predictive model
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: PredictionModel
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
slug | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "churn", "event" |
event_names | array<string> | Yes | |
horizon_days | integer | Yes | |
enabled | boolean | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
outcome | enum | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes | |
metrics | object | null | Yes | |
distribution | array<object> | Yes | |
distribution[].bucket | enum | Yes | Values: "low", "medium", "high" |
distribution[].users | integer | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"status": "idle",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"kind": "churn",
"event_names": [
"purchase"
],
"horizon_days": 1,
"outcome": "ready",
"last_computed_at": "örnek",
"scored_users": 1,
"metrics": {
"auc": 1.5,
"base_rate": 1.5,
"train_users": 1,
"holdout_users": 1,
"positives": 1,
"negatives": 1,
"calibration": [
{
"bucket": "low",
"users": 1,
"predicted": 1.5,
"actual": 1.5
}
],
"importance": [
{
"feature": "recency_days",
"weight": 1.5
}
]
},
"distribution": [
{
"bucket": "low",
"users": 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/predictions/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a predictive model
The model is retrained if the event or horizon changes; disabling deletes the scores.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdatePredictionDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
enabled | boolean | No | |
event_names | array<string> | No | Items: 1–10 |
horizon_days | integer | No | Range: 7–90 |
Example:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"event_names": [
"purchase"
],
"horizon_days": 7
}Responses
200 — Success.
Schema: PredictionModel
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
slug | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "churn", "event" |
event_names | array<string> | Yes | |
horizon_days | integer | Yes | |
enabled | boolean | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
outcome | enum | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes | |
metrics | object | null | Yes | |
distribution | array<object> | Yes | |
distribution[].bucket | enum | Yes | Values: "low", "medium", "high" |
distribution[].users | integer | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"status": "idle",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"kind": "churn",
"event_names": [
"purchase"
],
"horizon_days": 1,
"outcome": "ready",
"last_computed_at": "örnek",
"scored_users": 1,
"metrics": {
"auc": 1.5,
"base_rate": 1.5,
"train_users": 1,
"holdout_users": 1,
"positives": 1,
"negatives": 1,
"calibration": [
{
"bucket": "low",
"users": 1,
"predicted": 1.5,
"actual": 1.5
}
],
"importance": [
{
"feature": "recency_days",
"weight": 1.5
}
]
},
"distribution": [
{
"bucket": "low",
"users": 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 PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/predictions/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"enabled": true,
"event_names": [
"purchase"
],
"horizon_days": 7
}'Delete a predictive model
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
204 — Success.
No body.
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/predictions/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Retrain the model
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
202 — Success.
Schema: PredictionModel
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
slug | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "churn", "event" |
event_names | array<string> | Yes | |
horizon_days | integer | Yes | |
enabled | boolean | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
outcome | enum | null | Yes | |
last_computed_at | string | null | Yes | |
scored_users | integer | Yes | |
metrics | object | null | Yes | |
distribution | array<object> | Yes | |
distribution[].bucket | enum | Yes | Values: "low", "medium", "high" |
distribution[].users | integer | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"status": "idle",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"kind": "churn",
"event_names": [
"purchase"
],
"horizon_days": 1,
"outcome": "ready",
"last_computed_at": "örnek",
"scored_users": 1,
"metrics": {
"auc": 1.5,
"base_rate": 1.5,
"train_users": 1,
"holdout_users": 1,
"positives": 1,
"negatives": 1,
"calibration": [
{
"bucket": "low",
"users": 1,
"predicted": 1.5,
"actual": 1.5
}
],
"importance": [
{
"feature": "recency_days",
"weight": 1.5
}
]
},
"distribution": [
{
"bucket": "low",
"users": 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 POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/predictions/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/compute" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Users with a score
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
bucket | query | enum | No | Values: "low", "medium", "high" | "low" |
limit | query | integer | No | Range: 1–200 | 50 |
cursor | query | string | No | Length: 0–64 | "eyJpZCI6Im1zZ18wMUpE…" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: PredictionUsersPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].user_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].score | integer | Yes | |
data[].bucket | enum | Yes | Values: "low", "medium", "high" |
next_cursor | string | null | Yes |
Example response:
{
"data": [
{
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"score": 1,
"bucket": "low"
}
],
"next_cursor": "eyJpZCI6Im1zZ18wMUpE…"
}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/predictions/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/users?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Decision agents
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: DecisionAgentList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].slug | string | Yes | |
data[].name | string | Yes | |
data[].arms | array<object> | Yes | |
data[].arms[].id | string | Yes | |
data[].arms[].label | string | Yes | |
data[].reward_events | array<string> | Yes | |
data[].reward_window_hours | integer | Yes | |
data[].holdout_percent | integer | Yes | |
data[].context_prediction | string | null | Yes | |
data[].use_best_channel | boolean | Yes | |
data[].status | enum | Yes | Values: "active", "paused" |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"arms": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id"
}
],
"reward_events": [
"örnek"
],
"reward_window_hours": 1,
"holdout_percent": 1,
"context_prediction": "örnek",
"use_best_channel": true,
"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/decision-agents" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a decision agent
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: CreateDecisionAgentDto
| Field | Type | Required | Description |
|---|---|---|---|
slug | string | Yes | |
name | string | Yes | Length: 1–100 |
arms | array<object> | Yes | Items: 2–8 |
arms[].id | string | Yes | |
arms[].label | string | Yes | Length: 1–60 |
reward_events | array<string> | Yes | Items: 1–10 |
reward_window_hours | integer | No | Default: 72; Range: 1–720 |
holdout_percent | integer | No | Default: 10; Range: 0–50 |
context_prediction | string | null | No | |
use_best_channel | boolean | No | Default: false |
Example:
{
"name": "Sipariş bildirimleri",
"slug": "magaza",
"arms": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id"
}
],
"reward_events": [
"değer"
],
"reward_window_hours": 72,
"holdout_percent": 10,
"context_prediction": "değer",
"use_best_channel": false
}Responses
201 — Success.
Schema: DecisionAgent
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
slug | string | Yes | |
name | string | Yes | |
arms | array<object> | Yes | |
arms[].id | string | Yes | |
arms[].label | string | Yes | |
reward_events | array<string> | Yes | |
reward_window_hours | integer | Yes | |
holdout_percent | integer | Yes | |
context_prediction | string | null | Yes | |
use_best_channel | boolean | Yes | |
status | enum | Yes | Values: "active", "paused" |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"arms": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id"
}
],
"reward_events": [
"örnek"
],
"reward_window_hours": 1,
"holdout_percent": 1,
"context_prediction": "örnek",
"use_best_channel": true,
"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/decision-agents" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"slug": "magaza",
"arms": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id"
}
],
"reward_events": [
"değer"
],
"reward_window_hours": 72,
"holdout_percent": 10,
"context_prediction": "değer",
"use_best_channel": false
}'Decision agent
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: DecisionAgent
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
slug | string | Yes | |
name | string | Yes | |
arms | array<object> | Yes | |
arms[].id | string | Yes | |
arms[].label | string | Yes | |
reward_events | array<string> | Yes | |
reward_window_hours | integer | Yes | |
holdout_percent | integer | Yes | |
context_prediction | string | null | Yes | |
use_best_channel | boolean | Yes | |
status | enum | Yes | Values: "active", "paused" |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"arms": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id"
}
],
"reward_events": [
"örnek"
],
"reward_window_hours": 1,
"holdout_percent": 1,
"context_prediction": "örnek",
"use_best_channel": true,
"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/decision-agents/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a decision agent
Options cannot be changed: past learning depends on them. Create a new agent for new options.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateDecisionAgentDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
status | enum | No | Values: "active", "paused" |
reward_events | array<string> | No | Items: 1–10 |
reward_window_hours | integer | No | Range: 1–720 |
holdout_percent | integer | No | Range: 0–50 |
Example:
{
"name": "Sipariş bildirimleri",
"status": "active",
"reward_events": [
"değer"
],
"reward_window_hours": 1,
"holdout_percent": 1
}Responses
200 — Success.
Schema: DecisionAgent
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
slug | string | Yes | |
name | string | Yes | |
arms | array<object> | Yes | |
arms[].id | string | Yes | |
arms[].label | string | Yes | |
reward_events | array<string> | Yes | |
reward_window_hours | integer | Yes | |
holdout_percent | integer | Yes | |
context_prediction | string | null | Yes | |
use_best_channel | boolean | Yes | |
status | enum | Yes | Values: "active", "paused" |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"arms": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id"
}
],
"reward_events": [
"örnek"
],
"reward_window_hours": 1,
"holdout_percent": 1,
"context_prediction": "örnek",
"use_best_channel": true,
"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/decision-agents/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"status": "active",
"reward_events": [
"değer"
],
"reward_window_hours": 1,
"holdout_percent": 1
}'Delete a decision agent
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
204 — Success.
No body.
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/decision-agents/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Uplift report
Comparison of the learned policy and the control group.
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: DecisionReport
| Field | Type | Required | Description |
|---|---|---|---|
agent_id | string | Yes | |
days | integer | Yes | |
learned | object | Yes | |
learned.assignments | integer | Yes | |
learned.settled | integer | Yes | |
learned.rewards | integer | Yes | |
learned.rate | number | null | Yes | |
holdout | object | Yes | |
holdout.assignments | integer | Yes | |
holdout.settled | integer | Yes | |
holdout.rewards | integer | Yes | |
holdout.rate | number | null | Yes | |
lift | number | null | Yes | |
p_value | number | null | Yes | |
significant | boolean | Yes | |
arms | array<object> | Yes | |
arms[].id | string | Yes | |
arms[].label | string | Yes | |
arms[].share | number | Yes | |
arms[].assignments | integer | Yes | |
arms[].settled | integer | Yes | |
arms[].rewards | integer | Yes | |
arms[].rate | number | null | Yes | |
contexts | array<object> | Yes | |
contexts[].context | string | Yes | |
contexts[].arm_id | string | Yes | |
contexts[].settled | integer | Yes | |
contexts[].rate | number | null | Yes |
Example response:
{
"agent_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"days": 1,
"learned": {
"assignments": 1,
"settled": 1,
"rewards": 1,
"rate": 1.5
},
"holdout": {
"assignments": 1,
"settled": 1,
"rewards": 1,
"rate": 1.5
},
"lift": 1.5,
"p_value": 149.9,
"significant": true,
"arms": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id",
"share": 1.5,
"assignments": 1,
"settled": 1,
"rewards": 1,
"rate": 1.5
}
],
"contexts": [
{
"context": "örnek",
"arm_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"settled": 1,
"rate": 1.5
}
]
}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/decision-agents/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/report" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Make a decision for a user
The decision is recorded, and the agent learns as reward events arrive.
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: DecideDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | Yes | Length: 1–200 |
Example:
{
"external_id": "user_42"
}Responses
200 — Success.
Schema: DecisionResult
| Field | Type | Required | Description |
|---|---|---|---|
arm_id | string | Yes | |
label | string | Yes | |
policy | enum | Yes | Values: "thompson", "holdout" |
context | string | Yes |
Example response:
{
"arm_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id",
"policy": "thompson",
"context": "ö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/decision-agents/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/decide" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"external_id": "user_42"
}'Session volume and unique users for the last 14 days (daily totals)
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: SessionVolume
| Field | Type | Required | Description |
|---|---|---|---|
days | array<object> | Yes | |
days[].day | string | Yes | |
days[].sessions | integer | Yes | |
days[].users | integer | Yes |
Example response:
{
"days": [
{
"day": "örnek",
"sessions": 1,
"users": 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/analytics/sessions" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Overview KPIs
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
range | query | enum | No | Values: "7d", "30d"; Default: "7d" | "7d" |
from | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
to | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: OverviewStats
| Field | Type | Required | Description |
|---|---|---|---|
range | enum | Yes | Values: "7d", "30d", "custom" |
from | string | Yes | |
to | string | Yes | |
kpis | object | Yes | |
kpis.sent | integer | Yes | |
kpis.delivered | integer | Yes | |
kpis.failed | integer | Yes | |
kpis.opened | integer | Yes | |
kpis.clicked | integer | Yes | |
kpis.delivery_rate | number | null | Yes | |
kpis.open_rate | number | null | Yes | |
kpis.click_rate | number | null | Yes | |
kpis.active_subscriptions | integer | Yes | |
kpis.new_subscriptions | integer | Yes | |
kpis.opt_outs | integer | Yes | |
series | array<object> | Yes | |
series[].date | string | Yes | |
series[].sent | integer | Yes | |
series[].delivered | integer | Yes | |
series[].failed | integer | Yes | |
series[].opened | integer | Yes | |
recent_messages | array<object> | Yes | |
recent_messages[].id | string | Yes | |
recent_messages[].app_id | string | Yes | |
recent_messages[].source | enum | Yes | Values: "campaign", "api", "journey", "test" |
recent_messages[].status | enum | Yes | Values: "queued", "processing", "completed", "cancelled", "failed" |
recent_messages[].idempotency_key | string | null | Yes | |
recent_messages[].name | string | null | Yes | |
recent_messages[].content | map<string, any> | Yes | |
recent_messages[].target | map<string, any> | Yes | |
recent_messages[].options | map<string, any> | Yes | |
recent_messages[].labels | array<string> | Yes | |
recent_messages[].category | string | null | Yes | |
recent_messages[].template_id | string | null | Yes | |
recent_messages[].campaign_id | string | null | Yes | |
recent_messages[].variants | array<object> | null | Yes | |
recent_messages[].counts | object | Yes | |
recent_messages[].counts.targeted | integer | No | |
recent_messages[].counts.suppressed | integer | No | |
recent_messages[].counts.sent | integer | No | |
recent_messages[].counts.delivered | integer | No | |
recent_messages[].counts.failed | integer | No | |
recent_messages[].counts.errored | integer | No | |
recent_messages[].counts.expired | integer | No | |
recent_messages[].counts.opened | integer | No | |
recent_messages[].counts.clicked | integer | No | |
recent_messages[].counts.converted | integer | No | |
recent_messages[].counts.bounced | integer | No | |
recent_messages[].counts.complained | integer | No | |
recent_messages[].counts.unsubscribed | integer | No | |
recent_messages[].counts.sms_segments | integer | No | |
recent_messages[].requested_by | object | Yes | |
recent_messages[].requested_by.type | enum | Yes | Values: "api_key", "account", "system" |
recent_messages[].requested_by.id | string | No | |
recent_messages[].error | string | null | Yes | |
recent_messages[].scheduled_for | string | null | Yes | |
recent_messages[].started_at | string | null | Yes | |
recent_messages[].completed_at | string | null | Yes | |
recent_messages[].created_at | string | Yes | |
recent_messages[].updated_at | string | Yes | |
recent_campaigns | array<object> | Yes | |
recent_campaigns[].id | string | Yes | |
recent_campaigns[].name | string | Yes | |
recent_campaigns[].type | string | Yes | |
recent_campaigns[].status | string | Yes | |
recent_campaigns[].sent | integer | Yes | |
recent_campaigns[].opened | integer | Yes | |
recent_campaigns[].clicked | integer | Yes | |
recent_campaigns[].updated_at | string | Yes | |
top_errors | array<object> | Yes | |
top_errors[].code | string | Yes | |
top_errors[].count | integer | Yes | |
channels | array<object> | Yes | |
channels[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
channels[].provider | enum | null | Yes | |
channels[].status | enum | Yes | Values: "unconfigured", "active", "invalid", "suspended" |
channels[].last_error | string | null | Yes | |
channels[].active_subscriptions | integer | Yes |
Example response:
{
"channels": [
"web_push"
],
"range": "7d",
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"kpis": {
"sent": 1,
"delivered": 1,
"failed": 1,
"opened": 1,
"clicked": 1,
"delivery_rate": 1.5,
"open_rate": 1.5,
"click_rate": 1.5,
"active_subscriptions": 1,
"new_subscriptions": 1,
"opt_outs": 1
},
"series": [
{
"date": "örnek",
"sent": 1,
"delivered": 1,
"failed": 1,
"opened": 1
}
],
"recent_messages": [
{
"name": "Sipariş bildirimleri",
"target": {
"include_external_ids": [
"user_42"
]
},
"status": "queued",
"id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"source": "campaign",
"idempotency_key": "order-1001",
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"options": {},
"labels": [
"promo"
],
"category": "örnek",
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"is_control": true
}
],
"counts": {
"targeted": 1,
"suppressed": 1
},
"requested_by": {
"type": "api_key",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
},
"error": "örnek",
"scheduled_for": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}
],
"recent_campaigns": [
{
"name": "Sipariş bildirimleri",
"type": "örnek",
"status": "örnek",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"sent": 1,
"opened": 1,
"clicked": 1,
"updated_at": "örnek"
}
],
"top_errors": [
{
"code": "örnek",
"count": 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/analytics/overview" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Delivery report
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
from | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
to | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
compare | query | enum | No | Values: "true", "false" | "true" |
format | query | enum | No | Values: "json", "csv"; Default: "json" | "json" |
group_by | query | enum | No | Values: "day", "channel", "campaign"; Default: "day" | "day" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: MessagesReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
group_by | enum | Yes | Values: "day", "channel", "campaign" |
totals | object | Yes | |
totals.sent | integer | Yes | |
totals.delivered | integer | Yes | |
totals.failed | integer | Yes | |
totals.opened | integer | Yes | |
totals.clicked | integer | Yes | |
totals.converted | integer | Yes | |
totals.delivery_rate | number | null | Yes | |
totals.open_rate | number | null | Yes | |
totals.click_rate | number | null | Yes | |
previous | object | null | Yes | |
rows | array<object> | Yes | |
rows[].key | string | Yes | |
rows[].label | string | Yes | |
rows[].sent | integer | Yes | |
rows[].delivered | integer | Yes | |
rows[].failed | integer | Yes | |
rows[].opened | integer | Yes | |
rows[].clicked | integer | Yes | |
rows[].converted | integer | Yes |
Example response:
{
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"group_by": "day",
"totals": {
"sent": 1,
"delivered": 1,
"failed": 1,
"opened": 1,
"clicked": 1,
"converted": 1,
"delivery_rate": 1.5,
"open_rate": 1.5,
"click_rate": 1.5
},
"previous": {
"sent": 1,
"delivered": 1,
"failed": 1,
"opened": 1,
"clicked": 1,
"converted": 1,
"delivery_rate": 1.5,
"open_rate": 1.5,
"click_rate": 1.5
},
"rows": [
{
"key": "key-2026-10",
"label": "external_id",
"sent": 1,
"delivered": 1,
"failed": 1,
"opened": 1,
"clicked": 1,
"converted": 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/analytics/messages" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Subscription growth
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
from | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
to | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
compare | query | enum | No | Values: "true", "false" | "true" |
format | query | enum | No | Values: "json", "csv"; Default: "json" | "json" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: SubscriptionsReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
totals | object | Yes | |
totals.active | integer | Yes | |
totals.new | integer | Yes | |
totals.unsubscribed | integer | Yes | |
totals.opt_outs | integer | Yes | |
totals.net | integer | Yes | |
previous | object | null | Yes | |
rows | array<object> | Yes | |
rows[].date | string | Yes | |
rows[].new | integer | Yes | |
rows[].unsubscribed | integer | Yes | |
rows[].opt_outs | integer | Yes | |
rows[].net | integer | Yes | |
by_channel | array<object> | Yes | |
by_channel[].channel | string | Yes | |
by_channel[].active | integer | Yes | |
by_channel[].new | integer | Yes | |
by_channel[].unsubscribed | integer | Yes |
Example response:
{
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"totals": {
"active": 1,
"new": 1,
"unsubscribed": 1,
"opt_outs": 1,
"net": 1
},
"previous": {
"active": 1,
"new": 1,
"unsubscribed": 1,
"opt_outs": 1,
"net": 1
},
"rows": [
{
"date": "örnek",
"new": 1,
"unsubscribed": 1,
"opt_outs": 1,
"net": 1
}
],
"by_channel": [
{
"channel": "web_push",
"active": 1,
"new": 1,
"unsubscribed": 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/analytics/subscriptions" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"App uninstall report
Counted from the mobile push provider's "device not registered" response.
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
from | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
to | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
compare | query | enum | No | Values: "true", "false" | "true" |
format | query | enum | No | Values: "json", "csv"; Default: "json" | "json" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: UninstallReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
totals | object | Yes | |
totals.uninstalls | integer | Yes | |
totals.active | integer | Yes | |
totals.rate | number | null | Yes | |
previous | object | null | Yes | |
rows | array<object> | Yes | |
rows[].date | string | Yes | |
rows[].uninstalls | integer | Yes | |
by_channel | array<object> | Yes | |
by_channel[].channel | string | Yes | |
by_channel[].uninstalls | integer | Yes | |
by_channel[].active | integer | Yes | |
last_messages | array<object> | Yes | |
last_messages[].campaign_id | string | null | Yes | |
last_messages[].name | string | null | Yes | |
last_messages[].source | string | Yes | |
last_messages[].uninstalls | integer | Yes |
Example response:
{
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"totals": {
"uninstalls": 1,
"active": 1,
"rate": 1.5
},
"previous": {
"uninstalls": 1,
"active": 1,
"rate": 1.5
},
"rows": [
{
"date": "örnek",
"uninstalls": 1
}
],
"by_channel": [
{
"channel": "web_push",
"uninstalls": 1,
"active": 1
}
],
"last_messages": [
{
"name": "Sipariş bildirimleri",
"campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"source": "örnek",
"uninstalls": 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/analytics/uninstalls" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Android delivery health report
Sent, delivered and opened counts by manufacturer and ROM, plus the time from send to arrival on the device. Delivered is computed from the SDK receipt on the device, and the restriction summary from SDK diagnostics.
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
from | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
to | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
compare | query | enum | No | Values: "true", "false" | "true" |
format | query | enum | No | Values: "json", "csv"; Default: "json" | "json" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AndroidDeliveryReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
devices | object | Yes | |
devices.total | integer | Yes | |
devices.reporting | integer | Yes | |
devices.reporting_rate | number | null | Yes | |
devices.restricted | integer | Yes | |
devices.restricted_rate | number | null | Yes | |
devices.background_restricted | integer | Yes | |
devices.battery_optimized | integer | Yes | |
devices.low_standby_bucket | integer | Yes | |
devices.power_save | integer | Yes | |
devices.data_saver | integer | Yes | |
devices.channel_blocked | integer | Yes | |
devices.notifications_blocked | integer | Yes | |
devices.aggressive_vendor | integer | Yes | |
devices.aggressive_vendor_rate | number | null | Yes | |
totals | object | Yes | |
totals.sent | integer | Yes | |
totals.delivered | integer | Yes | |
totals.opened | integer | Yes | |
totals.delivery_rate | number | null | Yes | |
totals.open_rate | number | null | Yes | |
totals.median_delay_seconds | integer | null | Yes | |
totals.p90_delay_seconds | integer | null | Yes | |
previous | object | null | Yes | |
deprioritized | integer | Yes | |
aggressive | object | Yes | |
aggressive.sent | integer | Yes | |
aggressive.delivered | integer | Yes | |
aggressive.delivery_rate | number | null | Yes | |
others | object | Yes | |
others.sent | integer | Yes | |
others.delivered | integer | Yes | |
others.delivery_rate | number | null | Yes | |
vendors | array<object> | Yes | |
vendors[].vendor | string | Yes | |
vendors[].aggressive | boolean | Yes | |
vendors[].devices | integer | Yes | |
vendors[].reporting | integer | Yes | |
vendors[].restricted | integer | Yes | |
vendors[].battery_optimized | integer | Yes | |
vendors[].sent | integer | Yes | |
vendors[].delivered | integer | Yes | |
vendors[].opened | integer | Yes | |
vendors[].delivery_rate | number | null | Yes | |
vendors[].open_rate | number | null | Yes | |
vendors[].median_delay_seconds | integer | null | Yes | |
vendors[].p90_delay_seconds | integer | null | Yes | |
vendors[].deprioritized | integer | Yes | |
roms | array<object> | Yes | |
roms[].rom | string | Yes | |
roms[].devices | integer | Yes | |
roms[].restricted | integer | Yes | |
roms[].sent | integer | Yes | |
roms[].delivered | integer | Yes | |
roms[].delivery_rate | number | null | Yes | |
roms[].median_delay_seconds | integer | null | Yes | |
recommendations | array<enum> | Yes |
Example response:
{
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"devices": {
"total": 1,
"reporting": 1,
"reporting_rate": 1.5,
"restricted": 1,
"restricted_rate": 1.5,
"background_restricted": 1,
"battery_optimized": 1,
"low_standby_bucket": 1,
"power_save": 1,
"data_saver": 1,
"channel_blocked": 1,
"notifications_blocked": 1,
"aggressive_vendor": 1,
"aggressive_vendor_rate": 1.5
},
"totals": {
"sent": 1,
"delivered": 1,
"opened": 1,
"delivery_rate": 1.5,
"open_rate": 1.5,
"median_delay_seconds": 1,
"p90_delay_seconds": 1
},
"previous": {
"sent": 1,
"delivered": 1,
"opened": 1,
"delivery_rate": 1.5,
"open_rate": 1.5,
"median_delay_seconds": 1,
"p90_delay_seconds": 1
},
"deprioritized": 1,
"aggressive": {
"sent": 1,
"delivered": 1,
"delivery_rate": 1.5
},
"others": {
"sent": 1,
"delivered": 1,
"delivery_rate": 1.5
},
"vendors": [
{
"vendor": "örnek",
"aggressive": true,
"devices": 1,
"reporting": 1,
"restricted": 1,
"battery_optimized": 1,
"sent": 1,
"delivered": 1,
"opened": 1,
"delivery_rate": 1.5,
"open_rate": 1.5,
"median_delay_seconds": 1,
"p90_delay_seconds": 1,
"deprioritized": 1
}
],
"roms": [
{
"rom": "örnek",
"devices": 1,
"restricted": 1,
"sent": 1,
"delivered": 1,
"delivery_rate": 1.5,
"median_delay_seconds": 1
}
],
"recommendations": [
"upgrade_sdk"
]
}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/analytics/android-delivery" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Event volume
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
from | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
to | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
compare | query | enum | No | Values: "true", "false" | "true" |
format | query | enum | No | Values: "json", "csv"; Default: "json" | "json" |
name | query | string | No | Length: 1–100 | "Sipariş bildirimleri" |
group_by | query | enum | No | Values: "day", "name"; Default: "day" | "day" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: EventsReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
group_by | enum | Yes | Values: "day", "name" |
name | string | null | Yes | |
totals | object | Yes | |
totals.count | integer | Yes | |
totals.users | integer | Yes | |
previous | object | null | Yes | |
rows | array<object> | Yes | |
rows[].key | string | Yes | |
rows[].count | integer | Yes | |
rows[].users | integer | Yes |
Example response:
{
"name": "purchase",
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"group_by": "day",
"totals": {
"count": 1,
"users": 1
},
"previous": {
"count": 1,
"users": 1
},
"rows": [
{
"key": "key-2026-10",
"count": 1,
"users": 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/analytics/events" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Conversion/attribution
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
from | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
to | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
compare | query | enum | No | Values: "true", "false" | "true" |
format | query | enum | No | Values: "json", "csv"; Default: "json" | "json" |
campaign_id | query | string | No | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ConversionsReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
totals | object | Yes | |
totals.conversions | integer | Yes | |
totals.direct | integer | Yes | |
totals.influenced | integer | Yes | |
totals.unattributed | integer | Yes | |
totals.revenue | number | Yes | |
previous | object | null | Yes | |
by_campaign | array<object> | Yes | |
by_campaign[].campaign_id | string | null | Yes | |
by_campaign[].name | string | Yes | |
by_campaign[].conversions | integer | Yes | |
by_campaign[].direct | integer | Yes | |
by_campaign[].influenced | integer | Yes | |
by_campaign[].unattributed | integer | Yes | |
by_campaign[].revenue | number | Yes | |
by_campaign[].sent | integer | Yes | |
by_campaign[].conversion_rate | number | null | Yes | |
rows | array<object> | Yes | |
rows[].date | string | Yes | |
rows[].conversions | integer | Yes | |
rows[].revenue | number | Yes |
Example response:
{
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"totals": {
"conversions": 1,
"direct": 1,
"influenced": 1,
"unattributed": 1,
"revenue": 149.9
},
"previous": {
"conversions": 1,
"direct": 1,
"influenced": 1,
"unattributed": 1,
"revenue": 149.9
},
"by_campaign": [
{
"name": "Sipariş bildirimleri",
"campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"conversions": 1,
"direct": 1,
"influenced": 1,
"unattributed": 1,
"revenue": 149.9,
"sent": 1,
"conversion_rate": 1.5
}
],
"rows": [
{
"date": "örnek",
"conversions": 1,
"revenue": 149.9
}
]
}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/analytics/conversions" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Run a report
Produces a report from a selected source, metrics, dimensions and filters; fields are limited to an allowlist.
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: ReportRunBodyDto
| Field | Type | Required | Description |
|---|---|---|---|
source | enum | Yes | Values: "deliveries", "events", "conversions" |
metrics | array<enum> | Yes | Items: 1–8 |
dimensions | array<enum> | No | Default: []; Items: 0–2 |
filters | map<string, array<string>> | No | Default: {} |
sort | object | No | |
sort.by | string | Yes | Length: 0–64 |
sort.direction | enum | No | Values: "asc", "desc"; Default: "desc" |
limit | integer | No | Default: 100; Range: 1–1000 |
days | integer | No | Range: 1–730 |
from | string (date-time) | No | |
to | string (date-time) | No | |
format | enum | No | Values: "json", "csv"; Default: "json" |
Example:
{
"source": "deliveries",
"metrics": [
"sent"
],
"dimensions": [],
"filters": {},
"sort": {
"by": "örnek",
"direction": "desc"
},
"limit": 100,
"days": 1
}Responses
200 — Success.
Schema: ReportResult
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
columns | array<object> | Yes | |
columns[].key | string | Yes | |
columns[].kind | enum | Yes | Values: "dimension", "metric" |
columns[].format | enum | Yes | Values: "text", "date", "number", "percent" |
rows | array<map<string, string | number | null>> | Yes | |
totals | map<string, number | null> | null | Yes | |
truncated | boolean | Yes |
Example response:
{
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"columns": [
{
"key": "key-2026-10",
"kind": "dimension",
"format": "text"
}
],
"rows": [
{
"key": "user_42"
}
],
"totals": {
"key": 149.9
},
"truncated": 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 POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/analytics/reports/run" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"source": "deliveries",
"metrics": [
"sent"
],
"dimensions": [],
"filters": {},
"sort": {
"by": "örnek",
"direction": "desc"
},
"limit": 100,
"days": 1
}'Path analysis
Paths users followed after or before the starting event.
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: PathBodyDto
| Field | Type | Required | Description |
|---|---|---|---|
event | string | Yes | Length: 1–100 |
direction | enum | No | Values: "after", "before"; Default: "after" |
depth | integer | No | Default: 3; Range: 1–5 |
top | integer | No | Default: 5; Range: 2–10 |
window_hours | integer | No | Default: 24; Range: 1–720 |
exclude | array<string> | No | Default: []; Items: 0–20 |
from | string (date-time) | No | |
to | string (date-time) | No | |
format | enum | No | Values: "json", "csv"; Default: "json" |
Example:
{
"event": "purchase",
"direction": "after",
"depth": 3,
"top": 5,
"window_hours": 24,
"exclude": []
}Responses
200 — Success.
Schema: PathReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
event | string | Yes | |
direction | enum | Yes | Values: "after", "before" |
window_hours | integer | Yes | |
total_users | integer | Yes | |
truncated | boolean | Yes | |
levels | array<object> | Yes | |
levels[].step | integer | Yes | |
levels[].nodes | array<object> | Yes | |
levels[].nodes[].id | string | Yes | |
levels[].nodes[].name | string | null | Yes | |
levels[].nodes[].kind | enum | Yes | Values: "event", "other", "end" |
levels[].nodes[].users | integer | Yes | |
levels[].nodes[].share | number | Yes | |
links | array<object> | Yes | |
links[].source | string | Yes | |
links[].target | string | Yes | |
links[].users | integer | Yes | |
top_paths | array<object> | Yes | |
top_paths[].path | array<string> | Yes | |
top_paths[].users | integer | Yes | |
top_paths[].share | number | Yes |
Example response:
{
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"event": "purchase",
"direction": "after",
"window_hours": 1,
"total_users": 1,
"truncated": true,
"levels": [
{
"step": 1,
"nodes": [
{
"name": "Sipariş bildirimleri",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"kind": "event",
"users": 1,
"share": 1.5
}
]
}
],
"links": [
{
"target": "örnek",
"source": "örnek",
"users": 1
}
],
"top_paths": [
{
"path": [
"örnek"
],
"users": 1,
"share": 1.5
}
]
}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/analytics/paths" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"event": "purchase",
"direction": "after",
"depth": 3,
"top": 5,
"window_hours": 24,
"exclude": []
}'Funnel
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: FunnelBodyDto
| Field | Type | Required | Description |
|---|---|---|---|
steps | array<object> | Yes | Items: 2–8 |
steps[].name | string | Yes | Length: 1–100 |
steps[].where | object | No | |
steps[].where.key | string | Yes | Length: 1–64 |
steps[].where.value | string | Yes | Length: 0–500 |
from | string (date-time) | No | |
to | string (date-time) | No | |
window_hours | integer | No | Default: 72; Range: 1–720 |
compare | boolean | No | Default: false |
format | enum | No | Values: "json", "csv"; Default: "json" |
Example:
{
"steps": [
{
"name": "Sipariş bildirimleri",
"where": {
"key": "key-2026-10",
"value": "user_42"
}
}
],
"from": "2026-10-17T09:00:00Z",
"to": "2026-10-17T09:00:00Z",
"window_hours": 72,
"compare": false,
"format": "json"
}Responses
200 — Success.
Schema: FunnelReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
window_hours | integer | Yes | |
steps | array<object> | Yes | |
steps[].name | string | Yes | |
steps[].users | integer | Yes | |
steps[].conversion_rate | number | null | Yes | |
steps[].drop_off | integer | Yes | |
overall_rate | number | null | Yes | |
previous | object | null | Yes |
Example response:
{
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"window_hours": 1,
"steps": [
{
"name": "Sipariş bildirimleri",
"users": 1,
"conversion_rate": 1.5,
"drop_off": 1
}
],
"overall_rate": 1.5,
"previous": {
"steps": [
1
],
"overall_rate": 1.5
}
}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/analytics/funnels" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"steps": [
{
"name": "Sipariş bildirimleri",
"where": {
"key": "key-2026-10",
"value": "user_42"
}
}
],
"from": "2026-10-17T09:00:00Z",
"to": "2026-10-17T09:00:00Z",
"window_hours": 72,
"compare": false,
"format": "json"
}'Provider health
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
from | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
to | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
compare | query | enum | No | Values: "true", "false" | "true" |
format | query | enum | No | Values: "json", "csv"; Default: "json" | "json" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ProvidersReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
totals | object | Yes | |
totals.sent | integer | Yes | |
totals.failed | integer | Yes | |
totals.failure_rate | number | null | Yes | |
previous | object | null | Yes | |
rows | array<object> | Yes | |
rows[].channel | string | Yes | |
rows[].provider | string | null | Yes | |
rows[].sent | integer | Yes | |
rows[].failed | integer | Yes | |
rows[].failure_rate | number | null | Yes | |
rows[].latency_p50_ms | number | null | Yes | |
rows[].latency_p95_ms | number | null | Yes | |
rows[].errors | array<object> | Yes | |
rows[].errors[].code | string | Yes | |
rows[].errors[].count | integer | Yes |
Example response:
{
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"totals": {
"sent": 1,
"failed": 1,
"failure_rate": 1.5
},
"previous": {
"sent": 1,
"failed": 1,
"failure_rate": 1.5
},
"rows": [
{
"channel": "web_push",
"provider": "örnek",
"sent": 1,
"failed": 1,
"failure_rate": 1.5,
"latency_p50_ms": 1.5,
"latency_p95_ms": 1.5,
"errors": [
{
"code": "örnek",
"count": 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/analytics/providers" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Retention cohort
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
weeks | query | integer | No | Default: 8; Range: 2–26 | 2 |
format | query | enum | No | Values: "json", "csv"; Default: "json" | "json" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: RetentionReport
| Field | Type | Required | Description |
|---|---|---|---|
weeks | integer | Yes | |
cohorts | array<object> | Yes | |
cohorts[].week | string | Yes | |
cohorts[].users | integer | Yes | |
cohorts[].retention | array<number | null> | Yes | |
average | array<number | null> | Yes |
Example response:
{
"weeks": 1,
"cohorts": [
{
"week": "örnek",
"users": 1,
"retention": [
1.5
]
}
],
"average": [
1.5
]
}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/analytics/retention" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Engagement heatmap
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
from | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
to | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
compare | query | enum | No | Values: "true", "false" | "true" |
format | query | enum | No | Values: "json", "csv"; Default: "json" | "json" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: EngagementReport
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
timezone | string | Yes | |
totals | object | Yes | |
totals.opened | integer | Yes | |
totals.clicked | integer | Yes | |
previous | object | null | Yes | |
cells | array<object> | Yes | |
cells[].weekday | integer | Yes | |
cells[].hour | integer | Yes | |
cells[].opened | integer | Yes | |
cells[].clicked | integer | Yes | |
rows | array<object> | Yes | |
rows[].date | string | Yes | |
rows[].opened | integer | Yes | |
rows[].clicked | integer | Yes |
Example response:
{
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"timezone": "Europe/Istanbul",
"totals": {
"opened": 1,
"clicked": 1
},
"previous": {
"opened": 1,
"clicked": 1
},
"cells": [
{
"weekday": 1,
"hour": 1,
"opened": 1,
"clicked": 1
}
],
"rows": [
{
"date": "örnek",
"opened": 1,
"clicked": 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/analytics/engagement" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Global control group settings
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: GlobalControl
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
percent | integer | Yes | |
started_at | string | null | Yes |
Example response:
{
"enabled": true,
"percent": 1,
"started_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/global-control" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Configure the global control group
Users in the group do not receive campaigns, journeys or in-app messages. API and transactional sends are not affected.
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: UpdateGlobalControlDto
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
percent | integer | Yes | Range: 1–50 |
Example:
{
"enabled": true,
"percent": 1
}Responses
200 — Success.
Schema: GlobalControl
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
percent | integer | Yes | |
started_at | string | null | Yes |
Example response:
{
"enabled": true,
"percent": 1,
"started_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 PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/global-control" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"enabled": true,
"percent": 1
}'Rebuild the group (membership changes, measurement restarts)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: GlobalControl
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
percent | integer | Yes | |
started_at | string | null | Yes |
Example response:
{
"enabled": true,
"percent": 1,
"started_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/global-control/reset" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Conversion comparison between the control group and the group receiving messages
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
days | query | integer | No | Range: 1–365 | 1 |
event | query | string | No | Length: 1–128 | "purchase" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: GlobalControlReport
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
percent | integer | Yes | |
started_at | string | null | Yes | |
from | string | Yes | |
to | string | Yes | |
events | array<string> | Yes | |
control | object | Yes | |
control.users | integer | Yes | |
control.converted | integer | Yes | |
control.conversion_rate | number | Yes | |
treatment | object | Yes | |
treatment.users | integer | Yes | |
treatment.converted | integer | Yes | |
treatment.conversion_rate | number | Yes | |
lift_percent | number | null | Yes | |
incremental_conversions | integer | Yes | |
p_value | number | null | Yes | |
significant | boolean | Yes | |
withheld_messages | integer | Yes |
Example response:
{
"events": [
"purchase"
],
"enabled": true,
"percent": 1,
"started_at": "örnek",
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"control": {
"users": 1,
"converted": 1,
"conversion_rate": 1.5
},
"treatment": {
"users": 1,
"converted": 1,
"conversion_rate": 1.5
},
"lift_percent": 1.5,
"incremental_conversions": 1,
"p_value": 149.9,
"significant": true,
"withheld_messages": 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/global-control/report" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Saved reports
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: SavedReportList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].definition | object | Yes | |
data[].definition.source | enum | Yes | Values: "deliveries", "events", "conversions" |
data[].definition.metrics | array<enum> | Yes | Items: 1–8 |
data[].definition.dimensions | array<enum> | Yes | Default: []; Items: 0–2 |
data[].definition.filters | map<string, array<string>> | Yes | Default: {} |
data[].definition.sort | object | No | |
data[].definition.limit | integer | Yes | Default: 100; Range: 1–1000 |
data[].definition.days | integer | No | Range: 1–730 |
data[].definition.from | string (date-time) | No | |
data[].definition.to | string (date-time) | No | |
data[].created_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"definition": {
"source": "deliveries",
"metrics": [
"sent"
],
"dimensions": [],
"filters": {},
"limit": 100,
"sort": {
"by": "örnek",
"direction": "desc"
},
"days": 1
},
"created_by": "ö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/analytics/reports" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Save a report
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: CreateSavedReportDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–100 |
definition | object | Yes | |
definition.source | enum | Yes | Values: "deliveries", "events", "conversions" |
definition.metrics | array<enum> | Yes | Items: 1–8 |
definition.dimensions | array<enum> | No | Default: []; Items: 0–2 |
definition.filters | map<string, array<string>> | No | Default: {} |
definition.sort | object | No | |
definition.sort.by | string | Yes | Length: 0–64 |
definition.sort.direction | enum | No | Values: "asc", "desc"; Default: "desc" |
definition.limit | integer | No | Default: 100; Range: 1–1000 |
definition.days | integer | No | Range: 1–730 |
definition.from | string (date-time) | No | |
definition.to | string (date-time) | No |
Example:
{
"name": "Sipariş bildirimleri",
"definition": {
"source": "deliveries",
"metrics": [
"sent"
],
"dimensions": [],
"filters": {},
"sort": {
"by": "örnek",
"direction": "desc"
}
}
}Responses
201 — Success.
Schema: SavedReport
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
definition | object | Yes | |
definition.source | enum | Yes | Values: "deliveries", "events", "conversions" |
definition.metrics | array<enum> | Yes | Items: 1–8 |
definition.dimensions | array<enum> | Yes | Default: []; Items: 0–2 |
definition.filters | map<string, array<string>> | Yes | Default: {} |
definition.sort | object | No | |
definition.sort.by | string | Yes | Length: 0–64 |
definition.sort.direction | enum | Yes | Values: "asc", "desc"; Default: "desc" |
definition.limit | integer | Yes | Default: 100; Range: 1–1000 |
definition.days | integer | No | Range: 1–730 |
definition.from | string (date-time) | No | |
definition.to | string (date-time) | No | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"definition": {
"source": "deliveries",
"metrics": [
"sent"
],
"dimensions": [],
"filters": {},
"limit": 100,
"sort": {
"by": "örnek",
"direction": "desc"
},
"days": 1,
"from": "2026-10-17T09:00:00Z",
"to": "2026-10-17T09:00:00Z"
},
"created_by": "ö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/analytics/reports" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"definition": {
"source": "deliveries",
"metrics": [
"sent"
],
"dimensions": [],
"filters": {},
"sort": {
"by": "örnek",
"direction": "desc"
}
}
}'Saved report
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: SavedReport
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
definition | object | Yes | |
definition.source | enum | Yes | Values: "deliveries", "events", "conversions" |
definition.metrics | array<enum> | Yes | Items: 1–8 |
definition.dimensions | array<enum> | Yes | Default: []; Items: 0–2 |
definition.filters | map<string, array<string>> | Yes | Default: {} |
definition.sort | object | No | |
definition.sort.by | string | Yes | Length: 0–64 |
definition.sort.direction | enum | Yes | Values: "asc", "desc"; Default: "desc" |
definition.limit | integer | Yes | Default: 100; Range: 1–1000 |
definition.days | integer | No | Range: 1–730 |
definition.from | string (date-time) | No | |
definition.to | string (date-time) | No | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"definition": {
"source": "deliveries",
"metrics": [
"sent"
],
"dimensions": [],
"filters": {},
"limit": 100,
"sort": {
"by": "örnek",
"direction": "desc"
},
"days": 1,
"from": "2026-10-17T09:00:00Z",
"to": "2026-10-17T09:00:00Z"
},
"created_by": "ö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/analytics/reports/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a report
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateSavedReportDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
definition | object | No | |
definition.source | enum | Yes | Values: "deliveries", "events", "conversions" |
definition.metrics | array<enum> | Yes | Items: 1–8 |
definition.dimensions | array<enum> | No | Default: []; Items: 0–2 |
definition.filters | map<string, array<string>> | No | Default: {} |
definition.sort | object | No | |
definition.sort.by | string | Yes | Length: 0–64 |
definition.sort.direction | enum | No | Values: "asc", "desc"; Default: "desc" |
definition.limit | integer | No | Default: 100; Range: 1–1000 |
definition.days | integer | No | Range: 1–730 |
definition.from | string (date-time) | No | |
definition.to | string (date-time) | No |
Example:
{
"name": "Sipariş bildirimleri",
"definition": {
"source": "deliveries",
"metrics": [
"sent"
],
"dimensions": [],
"filters": {},
"sort": {
"by": "örnek",
"direction": "desc"
}
}
}Responses
200 — Success.
Schema: SavedReport
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
definition | object | Yes | |
definition.source | enum | Yes | Values: "deliveries", "events", "conversions" |
definition.metrics | array<enum> | Yes | Items: 1–8 |
definition.dimensions | array<enum> | Yes | Default: []; Items: 0–2 |
definition.filters | map<string, array<string>> | Yes | Default: {} |
definition.sort | object | No | |
definition.sort.by | string | Yes | Length: 0–64 |
definition.sort.direction | enum | Yes | Values: "asc", "desc"; Default: "desc" |
definition.limit | integer | Yes | Default: 100; Range: 1–1000 |
definition.days | integer | No | Range: 1–730 |
definition.from | string (date-time) | No | |
definition.to | string (date-time) | No | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"definition": {
"source": "deliveries",
"metrics": [
"sent"
],
"dimensions": [],
"filters": {},
"limit": 100,
"sort": {
"by": "örnek",
"direction": "desc"
},
"days": 1,
"from": "2026-10-17T09:00:00Z",
"to": "2026-10-17T09:00:00Z"
},
"created_by": "ö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/analytics/reports/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"definition": {
"source": "deliveries",
"metrics": [
"sent"
],
"dimensions": [],
"filters": {},
"sort": {
"by": "örnek",
"direction": "desc"
}
}
}'Delete a report
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
204 — Success.
No body.
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/analytics/reports/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Webhooks
Webhooks — 13 operations (GET /v1/apps/{appId}/webhooks/event-types, GET /v1/apps/{appId}/webhooks, POST /v1/apps/{appId}/webhooks, …). Generated from the OpenAPI 3.1.0 contract.
Export / import
Export / import — 6 operations (GET /v1/apps/{appId}/exports, POST /v1/apps/{appId}/exports, GET /v1/apps/{appId}/exports/{exportId}, …). Generated from the OpenAPI 3.1.0 contract.