PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/rfm/configRFM model
PUT/v1/apps/{appId}/rfm/configConfigure the RFM model
POST/v1/apps/{appId}/rfm/computeRecompute scores
GET/v1/apps/{appId}/rfm/overviewSegment distribution
GET/v1/apps/{appId}/rfm/transitionsSegment transitions between two dates
GET/v1/apps/{appId}/rfm/usersUsers with a score
GET/v1/apps/{appId}/affinity/configInterest model
PUT/v1/apps/{appId}/affinity/configConfigure the interest model
POST/v1/apps/{appId}/affinity/computeRecompute interests
GET/v1/apps/{appId}/affinity/overviewMost 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/configChannel score settings
PUT/v1/apps/{appId}/channel-scores/configConfigure channel scores
POST/v1/apps/{appId}/channel-scores/computeRecompute channel scores
GET/v1/apps/{appId}/channel-scores/overviewBest channel distribution
GET/v1/apps/{appId}/channel-scores/usersUsers with a known best channel
GET/v1/apps/{appId}/channel-scores/users/{userId}The user's channel scores
GET/v1/apps/{appId}/predictionsPredictive models
POST/v1/apps/{appId}/predictionsCreate 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}/computeRetrain the model
GET/v1/apps/{appId}/predictions/{id}/usersUsers with a score
GET/v1/apps/{appId}/decision-agentsDecision agents
POST/v1/apps/{appId}/decision-agentsCreate 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}/reportUplift report
POST/v1/apps/{appId}/decision-agents/{id}/decideMake a decision for a user
GET/v1/apps/{appId}/analytics/sessionsSession volume and unique users for the last 14 days (daily totals)
GET/v1/apps/{appId}/analytics/overviewOverview KPIs
GET/v1/apps/{appId}/analytics/messagesDelivery report
GET/v1/apps/{appId}/analytics/subscriptionsSubscription growth
GET/v1/apps/{appId}/analytics/uninstallsApp uninstall report
GET/v1/apps/{appId}/analytics/android-deliveryAndroid delivery health report
GET/v1/apps/{appId}/analytics/eventsEvent volume
GET/v1/apps/{appId}/analytics/conversionsConversion/attribution
POST/v1/apps/{appId}/analytics/reports/runRun a report
POST/v1/apps/{appId}/analytics/pathsPath analysis
POST/v1/apps/{appId}/analytics/funnelsFunnel
GET/v1/apps/{appId}/analytics/providersProvider health
GET/v1/apps/{appId}/analytics/retentionRetention cohort
GET/v1/apps/{appId}/analytics/engagementEngagement heatmap
GET/v1/apps/{appId}/global-controlGlobal control group settings
PUT/v1/apps/{appId}/global-controlConfigure the global control group
POST/v1/apps/{appId}/global-control/resetRebuild the group (membership changes, measurement restarts)
GET/v1/apps/{appId}/global-control/reportConversion comparison between the control group and the group receiving messages
GET/v1/apps/{appId}/analytics/reportsSaved reports
POST/v1/apps/{appId}/analytics/reportsSave 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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: RfmConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
event_namesarray<string>Yes
value_propertystring | nullYes
use_monetarybooleanYes
window_daysintegerYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
first_computed_atstring | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes

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

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

If the model is enabled, scores are recomputed after saving.

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateRfmConfigDto

FieldTypeRequiredDescription
enabledbooleanYes
event_namesarray<string>YesItems: 1–10
value_propertystring | nullNo
use_monetarybooleanNo
window_daysintegerNoRange: 30–730

Example:

{
  "enabled": true,
  "event_names": [
    "purchase"
  ],
  "value_property": "değer",
  "use_monetary": true,
  "window_days": 30
}

Responses

200 — Success.

Schema: RfmConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
event_namesarray<string>Yes
value_propertystring | nullYes
use_monetarybooleanYes
window_daysintegerYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
first_computed_atstring | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes

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

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

The job is queued; track progress via the status field.

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

202 — Success.

Schema: RfmConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
event_namesarray<string>Yes
value_propertystring | nullYes
use_monetarybooleanYes
window_daysintegerYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
first_computed_atstring | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: RfmOverview

FieldTypeRequiredDescription
totalintegerYes
low_populationbooleanYes
last_computed_atstring | nullYes
segmentsarray<object>Yes
segments[].segmentenumYesValues: "champions", "loyal", "potential", "new", "promising", "need_attention", "about_to_sleep", "at_risk", "cant_lose", "hibernating", "lost"
segments[].usersintegerYes
segments[].sharenumberYes
segments[].avg_recency_daysnumber | nullYes
segments[].avg_frequencynumber | nullYes
segments[].avg_monetarynumber | nullYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
fromquerystringNo"2026-10-01T00:00:00Z"
toquerystringNo"2026-10-17T00:00:00Z"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: RfmTransitions

FieldTypeRequiredDescription
fromstringYes
tostringYes
first_computed_atstring | nullYes
transitionsarray<object>Yes
transitions[].fromenum | nullYes
transitions[].toenum | nullYes
transitions[].usersintegerYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
segmentqueryenumNoValues: "champions", "loyal", "potential", "new", "promising", "need_attention", "about_to_sleep", "at_risk", "cant_lose", "hibernating", "lost""champions"
limitqueryintegerNoRange: 1–20050
cursorquerystringNoLength: 0–64"eyJpZCI6Im1zZ18wMUpE…"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: RfmUsersPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].user_idstringYes
data[].external_idstring | nullYes
data[].segmentenumYesValues: "champions", "loyal", "potential", "new", "promising", "need_attention", "about_to_sleep", "at_risk", "cant_lose", "hibernating", "lost"
data[].rintegerYes
data[].fintegerYes
data[].minteger | nullYes
data[].recency_daysintegerYes
data[].frequencyintegerYes
data[].monetarynumberYes
data[].last_event_atstringYes
data[].segment_sincestringYes
next_cursorstring | nullYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AffinityConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
attributesarray<string>Yes
eventsmap<string, number>Yes
window_daysintegerYes
half_life_daysintegerYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes

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

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

If the model is enabled, interests are recomputed after saving.

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateAffinityConfigDto

FieldTypeRequiredDescription
enabledbooleanYes
attributesarray<string>YesItems: 1–5
eventsmap<string, number>Yes
window_daysintegerNoRange: 7–365
half_life_daysintegerNoRange: 1–180

Example:

{
  "events": {
    "key": 149.9
  },
  "enabled": true,
  "attributes": [
    "değer"
  ],
  "window_days": 7,
  "half_life_days": 1
}

Responses

200 — Success.

Schema: AffinityConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
attributesarray<string>Yes
eventsmap<string, number>Yes
window_daysintegerYes
half_life_daysintegerYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

202 — Success.

Schema: AffinityConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
attributesarray<string>Yes
eventsmap<string, number>Yes
window_daysintegerYes
half_life_daysintegerYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AffinityOverview

FieldTypeRequiredDescription
last_computed_atstring | nullYes
scored_usersintegerYes
attributesarray<object>Yes
attributes[].attributestringYes
attributes[].valuesarray<object>Yes
attributes[].values[].valuestringYes
attributes[].values[].usersintegerYes
attributes[].values[].top_usersintegerYes

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

GET/v1/apps/{appId}/affinity/users/{userId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
userIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: UserAffinity

FieldTypeRequiredDescription
user_idstringYes
affinitiesarray<object>Yes
affinities[].attributestringYes
affinities[].valuestringYes
affinities[].scorenumberYes
affinities[].rankintegerYes
weekly_capinteger | nullYes
engagementnumber | nullYes
computed_atstring | nullYes

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

GET/v1/apps/{appId}/channel-scores/configTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ChannelScoreConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
window_daysintegerYes
min_sendsintegerYes
count_email_opensbooleanYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes

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

PUT/v1/apps/{appId}/channel-scores/configTry it (interactive API docs, new tab)

When enabled, scores are recomputed after saving; disabling deletes them.

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateChannelScoreConfigDto

FieldTypeRequiredDescription
enabledbooleanYes
window_daysintegerNoRange: 7–365
min_sendsintegerNoRange: 1–100
count_email_opensbooleanNo

Example:

{
  "enabled": true,
  "window_days": 7,
  "min_sends": 1,
  "count_email_opens": true
}

Responses

200 — Success.

Schema: ChannelScoreConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
window_daysintegerYes
min_sendsintegerYes
count_email_opensbooleanYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes

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

POST/v1/apps/{appId}/channel-scores/computeTry it (interactive API docs, new tab)

The job is queued; track progress via the status field.

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

202 — Success.

Schema: ChannelScoreConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
window_daysintegerYes
min_sendsintegerYes
count_email_opensbooleanYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes

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

GET/v1/apps/{appId}/channel-scores/overviewTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ChannelScoreOverview

FieldTypeRequiredDescription
totalintegerYes
low_populationbooleanYes
last_computed_atstring | nullYes
channelsarray<object>Yes
channels[].channelenumYesValues: "push", "email", "whatsapp", "rcs", "sms"
channels[].best_usersintegerYes
channels[].sharenumberYes
channels[].sendsintegerYes
channels[].engagedintegerYes
channels[].engagement_ratenumber | nullYes

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

GET/v1/apps/{appId}/channel-scores/usersTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
channelqueryenumNoValues: "push", "email", "whatsapp", "rcs", "sms""push"
limitqueryintegerNoRange: 1–20050
cursorquerystringNoLength: 0–64"eyJpZCI6Im1zZ18wMUpE…"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ChannelScoreUsersPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].user_idstringYes
data[].external_idstring | nullYes
data[].best_channelenum | nullYes
data[].scoresarray<object>Yes
data[].scores[].channelenumYesValues: "push", "email", "whatsapp", "rcs", "sms"
data[].scores[].sendsintegerYes
data[].scores[].engagedintegerYes
data[].scores[].scorenumberYes
next_cursorstring | nullYes

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

GET/v1/apps/{appId}/channel-scores/users/{userId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
userIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ChannelScoreUser

FieldTypeRequiredDescription
user_idstringYes
external_idstring | nullYes
best_channelenum | nullYes
scoresarray<object>Yes
scores[].channelenumYesValues: "push", "email", "whatsapp", "rcs", "sms"
scores[].sendsintegerYes
scores[].engagedintegerYes
scores[].scorenumberYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: PredictionModelList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].slugstringYes
data[].namestringYes
data[].kindenumYesValues: "churn", "event"
data[].event_namesarray<string>Yes
data[].horizon_daysintegerYes
data[].enabledbooleanYes
data[].statusenumYesValues: "idle", "queued", "running", "failed"
data[].outcomeenum | nullYes
data[].last_computed_atstring | nullYes
data[].scored_usersintegerYes
data[].metricsobject | nullYes
data[].distributionarray<object>Yes
data[].distribution[].bucketenumYesValues: "low", "medium", "high"
data[].distribution[].usersintegerYes

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

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

Training is queued; track the result via the outcome field.

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreatePredictionDto

FieldTypeRequiredDescription
slugstringYes
namestringYesLength: 1–100
kindenumYesValues: "churn", "event"
event_namesarray<string>NoDefault: []; Items: 0–10
horizon_daysintegerNoDefault: 30; Range: 7–90

Example:

{
  "name": "Sipariş bildirimleri",
  "slug": "magaza",
  "kind": "churn",
  "event_names": [],
  "horizon_days": 30
}

Responses

201 — Success.

Schema: PredictionModel

FieldTypeRequiredDescription
idstringYes
slugstringYes
namestringYes
kindenumYesValues: "churn", "event"
event_namesarray<string>Yes
horizon_daysintegerYes
enabledbooleanYes
statusenumYesValues: "idle", "queued", "running", "failed"
outcomeenum | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes
metricsobject | nullYes
distributionarray<object>Yes
distribution[].bucketenumYesValues: "low", "medium", "high"
distribution[].usersintegerYes

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

GET/v1/apps/{appId}/predictions/{id}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: PredictionModel

FieldTypeRequiredDescription
idstringYes
slugstringYes
namestringYes
kindenumYesValues: "churn", "event"
event_namesarray<string>Yes
horizon_daysintegerYes
enabledbooleanYes
statusenumYesValues: "idle", "queued", "running", "failed"
outcomeenum | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes
metricsobject | nullYes
distributionarray<object>Yes
distribution[].bucketenumYesValues: "low", "medium", "high"
distribution[].usersintegerYes

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

PATCH/v1/apps/{appId}/predictions/{id}Try it (interactive API docs, new tab)

The model is retrained if the event or horizon changes; disabling deletes the scores.

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

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdatePredictionDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
enabledbooleanNo
event_namesarray<string>NoItems: 1–10
horizon_daysintegerNoRange: 7–90

Example:

{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "event_names": [
    "purchase"
  ],
  "horizon_days": 7
}

Responses

200 — Success.

Schema: PredictionModel

FieldTypeRequiredDescription
idstringYes
slugstringYes
namestringYes
kindenumYesValues: "churn", "event"
event_namesarray<string>Yes
horizon_daysintegerYes
enabledbooleanYes
statusenumYesValues: "idle", "queued", "running", "failed"
outcomeenum | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes
metricsobject | nullYes
distributionarray<object>Yes
distribution[].bucketenumYesValues: "low", "medium", "high"
distribution[].usersintegerYes

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

DELETE/v1/apps/{appId}/predictions/{id}Try it (interactive API docs, new tab)

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

Parameters

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

POST/v1/apps/{appId}/predictions/{id}/computeTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

202 — Success.

Schema: PredictionModel

FieldTypeRequiredDescription
idstringYes
slugstringYes
namestringYes
kindenumYesValues: "churn", "event"
event_namesarray<string>Yes
horizon_daysintegerYes
enabledbooleanYes
statusenumYesValues: "idle", "queued", "running", "failed"
outcomeenum | nullYes
last_computed_atstring | nullYes
scored_usersintegerYes
metricsobject | nullYes
distributionarray<object>Yes
distribution[].bucketenumYesValues: "low", "medium", "high"
distribution[].usersintegerYes

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

GET/v1/apps/{appId}/predictions/{id}/usersTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
bucketqueryenumNoValues: "low", "medium", "high""low"
limitqueryintegerNoRange: 1–20050
cursorquerystringNoLength: 0–64"eyJpZCI6Im1zZ18wMUpE…"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: PredictionUsersPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].user_idstringYes
data[].external_idstring | nullYes
data[].scoreintegerYes
data[].bucketenumYesValues: "low", "medium", "high"
next_cursorstring | nullYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: DecisionAgentList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].slugstringYes
data[].namestringYes
data[].armsarray<object>Yes
data[].arms[].idstringYes
data[].arms[].labelstringYes
data[].reward_eventsarray<string>Yes
data[].reward_window_hoursintegerYes
data[].holdout_percentintegerYes
data[].context_predictionstring | nullYes
data[].use_best_channelbooleanYes
data[].statusenumYesValues: "active", "paused"
data[].created_atstringYes
data[].updated_atstringYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateDecisionAgentDto

FieldTypeRequiredDescription
slugstringYes
namestringYesLength: 1–100
armsarray<object>YesItems: 2–8
arms[].idstringYes
arms[].labelstringYesLength: 1–60
reward_eventsarray<string>YesItems: 1–10
reward_window_hoursintegerNoDefault: 72; Range: 1–720
holdout_percentintegerNoDefault: 10; Range: 0–50
context_predictionstring | nullNo
use_best_channelbooleanNoDefault: 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

FieldTypeRequiredDescription
idstringYes
slugstringYes
namestringYes
armsarray<object>Yes
arms[].idstringYes
arms[].labelstringYes
reward_eventsarray<string>Yes
reward_window_hoursintegerYes
holdout_percentintegerYes
context_predictionstring | nullYes
use_best_channelbooleanYes
statusenumYesValues: "active", "paused"
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/decision-agents/{id}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: DecisionAgent

FieldTypeRequiredDescription
idstringYes
slugstringYes
namestringYes
armsarray<object>Yes
arms[].idstringYes
arms[].labelstringYes
reward_eventsarray<string>Yes
reward_window_hoursintegerYes
holdout_percentintegerYes
context_predictionstring | nullYes
use_best_channelbooleanYes
statusenumYesValues: "active", "paused"
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/decision-agents/{id}Try it (interactive API docs, new tab)

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

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateDecisionAgentDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
statusenumNoValues: "active", "paused"
reward_eventsarray<string>NoItems: 1–10
reward_window_hoursintegerNoRange: 1–720
holdout_percentintegerNoRange: 0–50

Example:

{
  "name": "Sipariş bildirimleri",
  "status": "active",
  "reward_events": [
    "değer"
  ],
  "reward_window_hours": 1,
  "holdout_percent": 1
}

Responses

200 — Success.

Schema: DecisionAgent

FieldTypeRequiredDescription
idstringYes
slugstringYes
namestringYes
armsarray<object>Yes
arms[].idstringYes
arms[].labelstringYes
reward_eventsarray<string>Yes
reward_window_hoursintegerYes
holdout_percentintegerYes
context_predictionstring | nullYes
use_best_channelbooleanYes
statusenumYesValues: "active", "paused"
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/decision-agents/{id}Try it (interactive API docs, new tab)

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

Parameters

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

GET/v1/apps/{appId}/decision-agents/{id}/reportTry it (interactive API docs, new tab)

Comparison of the learned policy and the control group.

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

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: DecisionReport

FieldTypeRequiredDescription
agent_idstringYes
daysintegerYes
learnedobjectYes
learned.assignmentsintegerYes
learned.settledintegerYes
learned.rewardsintegerYes
learned.ratenumber | nullYes
holdoutobjectYes
holdout.assignmentsintegerYes
holdout.settledintegerYes
holdout.rewardsintegerYes
holdout.ratenumber | nullYes
liftnumber | nullYes
p_valuenumber | nullYes
significantbooleanYes
armsarray<object>Yes
arms[].idstringYes
arms[].labelstringYes
arms[].sharenumberYes
arms[].assignmentsintegerYes
arms[].settledintegerYes
arms[].rewardsintegerYes
arms[].ratenumber | nullYes
contextsarray<object>Yes
contexts[].contextstringYes
contexts[].arm_idstringYes
contexts[].settledintegerYes
contexts[].ratenumber | nullYes

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

POST/v1/apps/{appId}/decision-agents/{id}/decideTry it (interactive API docs, new tab)

The decision is recorded, and the agent learns as reward events arrive.

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

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: DecideDto

FieldTypeRequiredDescription
external_idstringYesLength: 1–200

Example:

{
  "external_id": "user_42"
}

Responses

200 — Success.

Schema: DecisionResult

FieldTypeRequiredDescription
arm_idstringYes
labelstringYes
policyenumYesValues: "thompson", "holdout"
contextstringYes

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)

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SessionVolume

FieldTypeRequiredDescription
daysarray<object>Yes
days[].daystringYes
days[].sessionsintegerYes
days[].usersintegerYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
rangequeryenumNoValues: "7d", "30d"; Default: "7d""7d"
fromquerystring (date-time)No"2026-10-17T09:00:00Z"
toquerystring (date-time)No"2026-10-17T09:00:00Z"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: OverviewStats

FieldTypeRequiredDescription
rangeenumYesValues: "7d", "30d", "custom"
fromstringYes
tostringYes
kpisobjectYes
kpis.sentintegerYes
kpis.deliveredintegerYes
kpis.failedintegerYes
kpis.openedintegerYes
kpis.clickedintegerYes
kpis.delivery_ratenumber | nullYes
kpis.open_ratenumber | nullYes
kpis.click_ratenumber | nullYes
kpis.active_subscriptionsintegerYes
kpis.new_subscriptionsintegerYes
kpis.opt_outsintegerYes
seriesarray<object>Yes
series[].datestringYes
series[].sentintegerYes
series[].deliveredintegerYes
series[].failedintegerYes
series[].openedintegerYes
recent_messagesarray<object>Yes
recent_messages[].idstringYes
recent_messages[].app_idstringYes
recent_messages[].sourceenumYesValues: "campaign", "api", "journey", "test"
recent_messages[].statusenumYesValues: "queued", "processing", "completed", "cancelled", "failed"
recent_messages[].idempotency_keystring | nullYes
recent_messages[].namestring | nullYes
recent_messages[].contentmap<string, any>Yes
recent_messages[].targetmap<string, any>Yes
recent_messages[].optionsmap<string, any>Yes
recent_messages[].labelsarray<string>Yes
recent_messages[].categorystring | nullYes
recent_messages[].template_idstring | nullYes
recent_messages[].campaign_idstring | nullYes
recent_messages[].variantsarray<object> | nullYes
recent_messages[].countsobjectYes
recent_messages[].counts.targetedintegerNo
recent_messages[].counts.suppressedintegerNo
recent_messages[].counts.sentintegerNo
recent_messages[].counts.deliveredintegerNo
recent_messages[].counts.failedintegerNo
recent_messages[].counts.erroredintegerNo
recent_messages[].counts.expiredintegerNo
recent_messages[].counts.openedintegerNo
recent_messages[].counts.clickedintegerNo
recent_messages[].counts.convertedintegerNo
recent_messages[].counts.bouncedintegerNo
recent_messages[].counts.complainedintegerNo
recent_messages[].counts.unsubscribedintegerNo
recent_messages[].counts.sms_segmentsintegerNo
recent_messages[].requested_byobjectYes
recent_messages[].requested_by.typeenumYesValues: "api_key", "account", "system"
recent_messages[].requested_by.idstringNo
recent_messages[].errorstring | nullYes
recent_messages[].scheduled_forstring | nullYes
recent_messages[].started_atstring | nullYes
recent_messages[].completed_atstring | nullYes
recent_messages[].created_atstringYes
recent_messages[].updated_atstringYes
recent_campaignsarray<object>Yes
recent_campaigns[].idstringYes
recent_campaigns[].namestringYes
recent_campaigns[].typestringYes
recent_campaigns[].statusstringYes
recent_campaigns[].sentintegerYes
recent_campaigns[].openedintegerYes
recent_campaigns[].clickedintegerYes
recent_campaigns[].updated_atstringYes
top_errorsarray<object>Yes
top_errors[].codestringYes
top_errors[].countintegerYes
channelsarray<object>Yes
channels[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
channels[].providerenum | nullYes
channels[].statusenumYesValues: "unconfigured", "active", "invalid", "suspended"
channels[].last_errorstring | nullYes
channels[].active_subscriptionsintegerYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
fromquerystring (date-time)No"2026-10-17T09:00:00Z"
toquerystring (date-time)No"2026-10-17T09:00:00Z"
comparequeryenumNoValues: "true", "false""true"
formatqueryenumNoValues: "json", "csv"; Default: "json""json"
group_byqueryenumNoValues: "day", "channel", "campaign"; Default: "day""day"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: MessagesReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
group_byenumYesValues: "day", "channel", "campaign"
totalsobjectYes
totals.sentintegerYes
totals.deliveredintegerYes
totals.failedintegerYes
totals.openedintegerYes
totals.clickedintegerYes
totals.convertedintegerYes
totals.delivery_ratenumber | nullYes
totals.open_ratenumber | nullYes
totals.click_ratenumber | nullYes
previousobject | nullYes
rowsarray<object>Yes
rows[].keystringYes
rows[].labelstringYes
rows[].sentintegerYes
rows[].deliveredintegerYes
rows[].failedintegerYes
rows[].openedintegerYes
rows[].clickedintegerYes
rows[].convertedintegerYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
fromquerystring (date-time)No"2026-10-17T09:00:00Z"
toquerystring (date-time)No"2026-10-17T09:00:00Z"
comparequeryenumNoValues: "true", "false""true"
formatqueryenumNoValues: "json", "csv"; Default: "json""json"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SubscriptionsReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
totalsobjectYes
totals.activeintegerYes
totals.newintegerYes
totals.unsubscribedintegerYes
totals.opt_outsintegerYes
totals.netintegerYes
previousobject | nullYes
rowsarray<object>Yes
rows[].datestringYes
rows[].newintegerYes
rows[].unsubscribedintegerYes
rows[].opt_outsintegerYes
rows[].netintegerYes
by_channelarray<object>Yes
by_channel[].channelstringYes
by_channel[].activeintegerYes
by_channel[].newintegerYes
by_channel[].unsubscribedintegerYes

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

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

Counted from the mobile push provider's "device not registered" response.

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

Parameters

NameInTypeRequiredDescriptionExample
fromquerystring (date-time)No"2026-10-17T09:00:00Z"
toquerystring (date-time)No"2026-10-17T09:00:00Z"
comparequeryenumNoValues: "true", "false""true"
formatqueryenumNoValues: "json", "csv"; Default: "json""json"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: UninstallReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
totalsobjectYes
totals.uninstallsintegerYes
totals.activeintegerYes
totals.ratenumber | nullYes
previousobject | nullYes
rowsarray<object>Yes
rows[].datestringYes
rows[].uninstallsintegerYes
by_channelarray<object>Yes
by_channel[].channelstringYes
by_channel[].uninstallsintegerYes
by_channel[].activeintegerYes
last_messagesarray<object>Yes
last_messages[].campaign_idstring | nullYes
last_messages[].namestring | nullYes
last_messages[].sourcestringYes
last_messages[].uninstallsintegerYes

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

GET/v1/apps/{appId}/analytics/android-deliveryTry it (interactive API docs, new tab)

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

NameInTypeRequiredDescriptionExample
fromquerystring (date-time)No"2026-10-17T09:00:00Z"
toquerystring (date-time)No"2026-10-17T09:00:00Z"
comparequeryenumNoValues: "true", "false""true"
formatqueryenumNoValues: "json", "csv"; Default: "json""json"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AndroidDeliveryReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
devicesobjectYes
devices.totalintegerYes
devices.reportingintegerYes
devices.reporting_ratenumber | nullYes
devices.restrictedintegerYes
devices.restricted_ratenumber | nullYes
devices.background_restrictedintegerYes
devices.battery_optimizedintegerYes
devices.low_standby_bucketintegerYes
devices.power_saveintegerYes
devices.data_saverintegerYes
devices.channel_blockedintegerYes
devices.notifications_blockedintegerYes
devices.aggressive_vendorintegerYes
devices.aggressive_vendor_ratenumber | nullYes
totalsobjectYes
totals.sentintegerYes
totals.deliveredintegerYes
totals.openedintegerYes
totals.delivery_ratenumber | nullYes
totals.open_ratenumber | nullYes
totals.median_delay_secondsinteger | nullYes
totals.p90_delay_secondsinteger | nullYes
previousobject | nullYes
deprioritizedintegerYes
aggressiveobjectYes
aggressive.sentintegerYes
aggressive.deliveredintegerYes
aggressive.delivery_ratenumber | nullYes
othersobjectYes
others.sentintegerYes
others.deliveredintegerYes
others.delivery_ratenumber | nullYes
vendorsarray<object>Yes
vendors[].vendorstringYes
vendors[].aggressivebooleanYes
vendors[].devicesintegerYes
vendors[].reportingintegerYes
vendors[].restrictedintegerYes
vendors[].battery_optimizedintegerYes
vendors[].sentintegerYes
vendors[].deliveredintegerYes
vendors[].openedintegerYes
vendors[].delivery_ratenumber | nullYes
vendors[].open_ratenumber | nullYes
vendors[].median_delay_secondsinteger | nullYes
vendors[].p90_delay_secondsinteger | nullYes
vendors[].deprioritizedintegerYes
romsarray<object>Yes
roms[].romstringYes
roms[].devicesintegerYes
roms[].restrictedintegerYes
roms[].sentintegerYes
roms[].deliveredintegerYes
roms[].delivery_ratenumber | nullYes
roms[].median_delay_secondsinteger | nullYes
recommendationsarray<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

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

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

Parameters

NameInTypeRequiredDescriptionExample
fromquerystring (date-time)No"2026-10-17T09:00:00Z"
toquerystring (date-time)No"2026-10-17T09:00:00Z"
comparequeryenumNoValues: "true", "false""true"
formatqueryenumNoValues: "json", "csv"; Default: "json""json"
namequerystringNoLength: 1–100"Sipariş bildirimleri"
group_byqueryenumNoValues: "day", "name"; Default: "day""day"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: EventsReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
group_byenumYesValues: "day", "name"
namestring | nullYes
totalsobjectYes
totals.countintegerYes
totals.usersintegerYes
previousobject | nullYes
rowsarray<object>Yes
rows[].keystringYes
rows[].countintegerYes
rows[].usersintegerYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
fromquerystring (date-time)No"2026-10-17T09:00:00Z"
toquerystring (date-time)No"2026-10-17T09:00:00Z"
comparequeryenumNoValues: "true", "false""true"
formatqueryenumNoValues: "json", "csv"; Default: "json""json"
campaign_idquerystringNo"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ConversionsReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
totalsobjectYes
totals.conversionsintegerYes
totals.directintegerYes
totals.influencedintegerYes
totals.unattributedintegerYes
totals.revenuenumberYes
previousobject | nullYes
by_campaignarray<object>Yes
by_campaign[].campaign_idstring | nullYes
by_campaign[].namestringYes
by_campaign[].conversionsintegerYes
by_campaign[].directintegerYes
by_campaign[].influencedintegerYes
by_campaign[].unattributedintegerYes
by_campaign[].revenuenumberYes
by_campaign[].sentintegerYes
by_campaign[].conversion_ratenumber | nullYes
rowsarray<object>Yes
rows[].datestringYes
rows[].conversionsintegerYes
rows[].revenuenumberYes

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

POST/v1/apps/{appId}/analytics/reports/runTry it (interactive API docs, new tab)

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

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: ReportRunBodyDto

FieldTypeRequiredDescription
sourceenumYesValues: "deliveries", "events", "conversions"
metricsarray<enum>YesItems: 1–8
dimensionsarray<enum>NoDefault: []; Items: 0–2
filtersmap<string, array<string>>NoDefault: {}
sortobjectNo
sort.bystringYesLength: 0–64
sort.directionenumNoValues: "asc", "desc"; Default: "desc"
limitintegerNoDefault: 100; Range: 1–1000
daysintegerNoRange: 1–730
fromstring (date-time)No
tostring (date-time)No
formatenumNoValues: "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

FieldTypeRequiredDescription
fromstringYes
tostringYes
columnsarray<object>Yes
columns[].keystringYes
columns[].kindenumYesValues: "dimension", "metric"
columns[].formatenumYesValues: "text", "date", "number", "percent"
rowsarray<map<string, string | number | null>>Yes
totalsmap<string, number | null> | nullYes
truncatedbooleanYes

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

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

Paths users followed after or before the starting event.

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: PathBodyDto

FieldTypeRequiredDescription
eventstringYesLength: 1–100
directionenumNoValues: "after", "before"; Default: "after"
depthintegerNoDefault: 3; Range: 1–5
topintegerNoDefault: 5; Range: 2–10
window_hoursintegerNoDefault: 24; Range: 1–720
excludearray<string>NoDefault: []; Items: 0–20
fromstring (date-time)No
tostring (date-time)No
formatenumNoValues: "json", "csv"; Default: "json"

Example:

{
  "event": "purchase",
  "direction": "after",
  "depth": 3,
  "top": 5,
  "window_hours": 24,
  "exclude": []
}

Responses

200 — Success.

Schema: PathReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
eventstringYes
directionenumYesValues: "after", "before"
window_hoursintegerYes
total_usersintegerYes
truncatedbooleanYes
levelsarray<object>Yes
levels[].stepintegerYes
levels[].nodesarray<object>Yes
levels[].nodes[].idstringYes
levels[].nodes[].namestring | nullYes
levels[].nodes[].kindenumYesValues: "event", "other", "end"
levels[].nodes[].usersintegerYes
levels[].nodes[].sharenumberYes
linksarray<object>Yes
links[].sourcestringYes
links[].targetstringYes
links[].usersintegerYes
top_pathsarray<object>Yes
top_paths[].patharray<string>Yes
top_paths[].usersintegerYes
top_paths[].sharenumberYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: FunnelBodyDto

FieldTypeRequiredDescription
stepsarray<object>YesItems: 2–8
steps[].namestringYesLength: 1–100
steps[].whereobjectNo
steps[].where.keystringYesLength: 1–64
steps[].where.valuestringYesLength: 0–500
fromstring (date-time)No
tostring (date-time)No
window_hoursintegerNoDefault: 72; Range: 1–720
comparebooleanNoDefault: false
formatenumNoValues: "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

FieldTypeRequiredDescription
fromstringYes
tostringYes
window_hoursintegerYes
stepsarray<object>Yes
steps[].namestringYes
steps[].usersintegerYes
steps[].conversion_ratenumber | nullYes
steps[].drop_offintegerYes
overall_ratenumber | nullYes
previousobject | nullYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
fromquerystring (date-time)No"2026-10-17T09:00:00Z"
toquerystring (date-time)No"2026-10-17T09:00:00Z"
comparequeryenumNoValues: "true", "false""true"
formatqueryenumNoValues: "json", "csv"; Default: "json""json"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ProvidersReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
totalsobjectYes
totals.sentintegerYes
totals.failedintegerYes
totals.failure_ratenumber | nullYes
previousobject | nullYes
rowsarray<object>Yes
rows[].channelstringYes
rows[].providerstring | nullYes
rows[].sentintegerYes
rows[].failedintegerYes
rows[].failure_ratenumber | nullYes
rows[].latency_p50_msnumber | nullYes
rows[].latency_p95_msnumber | nullYes
rows[].errorsarray<object>Yes
rows[].errors[].codestringYes
rows[].errors[].countintegerYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
weeksqueryintegerNoDefault: 8; Range: 2–262
formatqueryenumNoValues: "json", "csv"; Default: "json""json"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: RetentionReport

FieldTypeRequiredDescription
weeksintegerYes
cohortsarray<object>Yes
cohorts[].weekstringYes
cohorts[].usersintegerYes
cohorts[].retentionarray<number | null>Yes
averagearray<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

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

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

Parameters

NameInTypeRequiredDescriptionExample
fromquerystring (date-time)No"2026-10-17T09:00:00Z"
toquerystring (date-time)No"2026-10-17T09:00:00Z"
comparequeryenumNoValues: "true", "false""true"
formatqueryenumNoValues: "json", "csv"; Default: "json""json"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: EngagementReport

FieldTypeRequiredDescription
fromstringYes
tostringYes
timezonestringYes
totalsobjectYes
totals.openedintegerYes
totals.clickedintegerYes
previousobject | nullYes
cellsarray<object>Yes
cells[].weekdayintegerYes
cells[].hourintegerYes
cells[].openedintegerYes
cells[].clickedintegerYes
rowsarray<object>Yes
rows[].datestringYes
rows[].openedintegerYes
rows[].clickedintegerYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: GlobalControl

FieldTypeRequiredDescription
enabledbooleanYes
percentintegerYes
started_atstring | nullYes

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

PUT/v1/apps/{appId}/global-controlTry it (interactive API docs, new tab)

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

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateGlobalControlDto

FieldTypeRequiredDescription
enabledbooleanYes
percentintegerYesRange: 1–50

Example:

{
  "enabled": true,
  "percent": 1
}

Responses

200 — Success.

Schema: GlobalControl

FieldTypeRequiredDescription
enabledbooleanYes
percentintegerYes
started_atstring | nullYes

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)

POST/v1/apps/{appId}/global-control/resetTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: GlobalControl

FieldTypeRequiredDescription
enabledbooleanYes
percentintegerYes
started_atstring | nullYes

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

GET/v1/apps/{appId}/global-control/reportTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
daysqueryintegerNoRange: 1–3651
eventquerystringNoLength: 1–128"purchase"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: GlobalControlReport

FieldTypeRequiredDescription
enabledbooleanYes
percentintegerYes
started_atstring | nullYes
fromstringYes
tostringYes
eventsarray<string>Yes
controlobjectYes
control.usersintegerYes
control.convertedintegerYes
control.conversion_ratenumberYes
treatmentobjectYes
treatment.usersintegerYes
treatment.convertedintegerYes
treatment.conversion_ratenumberYes
lift_percentnumber | nullYes
incremental_conversionsintegerYes
p_valuenumber | nullYes
significantbooleanYes
withheld_messagesintegerYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SavedReportList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].definitionobjectYes
data[].definition.sourceenumYesValues: "deliveries", "events", "conversions"
data[].definition.metricsarray<enum>YesItems: 1–8
data[].definition.dimensionsarray<enum>YesDefault: []; Items: 0–2
data[].definition.filtersmap<string, array<string>>YesDefault: {}
data[].definition.sortobjectNo
data[].definition.limitintegerYesDefault: 100; Range: 1–1000
data[].definition.daysintegerNoRange: 1–730
data[].definition.fromstring (date-time)No
data[].definition.tostring (date-time)No
data[].created_bystring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateSavedReportDto

FieldTypeRequiredDescription
namestringYesLength: 1–100
definitionobjectYes
definition.sourceenumYesValues: "deliveries", "events", "conversions"
definition.metricsarray<enum>YesItems: 1–8
definition.dimensionsarray<enum>NoDefault: []; Items: 0–2
definition.filtersmap<string, array<string>>NoDefault: {}
definition.sortobjectNo
definition.sort.bystringYesLength: 0–64
definition.sort.directionenumNoValues: "asc", "desc"; Default: "desc"
definition.limitintegerNoDefault: 100; Range: 1–1000
definition.daysintegerNoRange: 1–730
definition.fromstring (date-time)No
definition.tostring (date-time)No

Example:

{
  "name": "Sipariş bildirimleri",
  "definition": {
    "source": "deliveries",
    "metrics": [
      "sent"
    ],
    "dimensions": [],
    "filters": {},
    "sort": {
      "by": "örnek",
      "direction": "desc"
    }
  }
}

Responses

201 — Success.

Schema: SavedReport

FieldTypeRequiredDescription
idstringYes
namestringYes
definitionobjectYes
definition.sourceenumYesValues: "deliveries", "events", "conversions"
definition.metricsarray<enum>YesItems: 1–8
definition.dimensionsarray<enum>YesDefault: []; Items: 0–2
definition.filtersmap<string, array<string>>YesDefault: {}
definition.sortobjectNo
definition.sort.bystringYesLength: 0–64
definition.sort.directionenumYesValues: "asc", "desc"; Default: "desc"
definition.limitintegerYesDefault: 100; Range: 1–1000
definition.daysintegerNoRange: 1–730
definition.fromstring (date-time)No
definition.tostring (date-time)No
created_bystring | nullYes
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/analytics/reports/{id}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SavedReport

FieldTypeRequiredDescription
idstringYes
namestringYes
definitionobjectYes
definition.sourceenumYesValues: "deliveries", "events", "conversions"
definition.metricsarray<enum>YesItems: 1–8
definition.dimensionsarray<enum>YesDefault: []; Items: 0–2
definition.filtersmap<string, array<string>>YesDefault: {}
definition.sortobjectNo
definition.sort.bystringYesLength: 0–64
definition.sort.directionenumYesValues: "asc", "desc"; Default: "desc"
definition.limitintegerYesDefault: 100; Range: 1–1000
definition.daysintegerNoRange: 1–730
definition.fromstring (date-time)No
definition.tostring (date-time)No
created_bystring | nullYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/analytics/reports/{id}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateSavedReportDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
definitionobjectNo
definition.sourceenumYesValues: "deliveries", "events", "conversions"
definition.metricsarray<enum>YesItems: 1–8
definition.dimensionsarray<enum>NoDefault: []; Items: 0–2
definition.filtersmap<string, array<string>>NoDefault: {}
definition.sortobjectNo
definition.sort.bystringYesLength: 0–64
definition.sort.directionenumNoValues: "asc", "desc"; Default: "desc"
definition.limitintegerNoDefault: 100; Range: 1–1000
definition.daysintegerNoRange: 1–730
definition.fromstring (date-time)No
definition.tostring (date-time)No

Example:

{
  "name": "Sipariş bildirimleri",
  "definition": {
    "source": "deliveries",
    "metrics": [
      "sent"
    ],
    "dimensions": [],
    "filters": {},
    "sort": {
      "by": "örnek",
      "direction": "desc"
    }
  }
}

Responses

200 — Success.

Schema: SavedReport

FieldTypeRequiredDescription
idstringYes
namestringYes
definitionobjectYes
definition.sourceenumYesValues: "deliveries", "events", "conversions"
definition.metricsarray<enum>YesItems: 1–8
definition.dimensionsarray<enum>YesDefault: []; Items: 0–2
definition.filtersmap<string, array<string>>YesDefault: {}
definition.sortobjectNo
definition.sort.bystringYesLength: 0–64
definition.sort.directionenumYesValues: "asc", "desc"; Default: "desc"
definition.limitintegerYesDefault: 100; Range: 1–1000
definition.daysintegerNoRange: 1–730
definition.fromstring (date-time)No
definition.tostring (date-time)No
created_bystring | nullYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/analytics/reports/{id}Try it (interactive API docs, new tab)

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

Parameters

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

On this page

OperationsDetailsRFM model200 — Success.Configure the RFM model200 — Success.Recompute scores202 — Success.Segment distribution200 — Success.Segment transitions between two dates200 — Success.Users with a score200 — Success.Interest model200 — Success.Configure the interest model200 — Success.Recompute interests202 — Success.Most common interests per attribute200 — Success.The contact's interests and weekly frequency cap200 — Success.Channel score settings200 — Success.Configure channel scores200 — Success.Recompute channel scores202 — Success.Best channel distribution200 — Success.Users with a known best channel200 — Success.The user's channel scores200 — Success.Predictive models200 — Success.Create a predictive model201 — Success.Predictive model200 — Success.Update a predictive model200 — Success.Delete a predictive model204 — Success.Retrain the model202 — Success.Users with a score200 — Success.Decision agents200 — Success.Create a decision agent201 — Success.Decision agent200 — Success.Update a decision agent200 — Success.Delete a decision agent204 — Success.Uplift report200 — Success.Make a decision for a user200 — Success.Session volume and unique users for the last 14 days (daily totals)200 — Success.Overview KPIs200 — Success.Delivery report200 — Success.Subscription growth200 — Success.App uninstall report200 — Success.Android delivery health report200 — Success.Event volume200 — Success.Conversion/attribution200 — Success.Run a report200 — Success.Path analysis200 — Success.Funnel200 — Success.Provider health200 — Success.Retention cohort200 — Success.Engagement heatmap200 — Success.Global control group settings200 — Success.Configure the global control group200 — Success.Rebuild the group (membership changes, measurement restarts)200 — Success.Conversion comparison between the control group and the group receiving messages200 — Success.Saved reports200 — Success.Save a report201 — Success.Saved report200 — Success.Update a report200 — Success.Delete a report204 — Success.