PushizoDocs
API reference

Event definitions

Event definitions — 4 operations (GET /v1/apps/{appId}/events/definitions, GET /v1/apps/{appId}/events/definitions/{name}, PATCH /v1/apps/{appId}/events/definitions/{name}, …). Generated from the OpenAPI 3.1.0 contract.

Definitions of custom events seen in the app (name, first/last seen, 30-day count) and the editable fields on each definition.

Base URL: https://api.pushizo.com · Tag: events · Interactive docs (Scalar)

Operations

MethodPathOperation
GET/v1/apps/{appId}/events/definitionsEvent definitions
GET/v1/apps/{appId}/events/definitions/{name}Event details
PATCH/v1/apps/{appId}/events/definitions/{name}Display name / conversion flag
GET/v1/apps/{appId}/events/recentRecent events (with user ID and properties; name and time filters)

Details

Event definitions

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

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

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 500; Range: 1–50050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: EventDefinitionList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].display_namestring | nullYes
data[].properties_schemamap<string, string>Yes
data[].is_conversionbooleanYes
data[].outcome_uniquebooleanYes
data[].outcome_unattributedbooleanYes
data[].retention_daysinteger | nullYes
data[].first_seen_atstringYes
data[].last_seen_atstringYes
data[].count_30dintegerYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "display_name": "örnek",
      "properties_schema": {
        "key": "user_42"
      },
      "is_conversion": true,
      "outcome_unique": true,
      "outcome_unattributed": true,
      "retention_days": 1,
      "first_seen_at": "örnek",
      "last_seen_at": "örnek",
      "count_30d": 1,
      "created_at": "örnek",
      "updated_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

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

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/events/definitions?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Event details

GET/v1/apps/{appId}/events/definitions/{name}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
namepathstringYes"Sipariş bildirimleri"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: EventDefinitionDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
display_namestring | nullYes
properties_schemamap<string, string>Yes
is_conversionbooleanYes
outcome_uniquebooleanYes
outcome_unattributedbooleanYes
retention_daysinteger | nullYes
first_seen_atstringYes
last_seen_atstringYes
count_30dintegerYes
created_atstringYes
updated_atstringYes
dailyarray<object>Yes
daily[].datestringYes
daily[].countintegerYes
daily[].usersintegerYes
propertiesarray<object>Yes
properties[].keystringYes
properties[].typestringYes
properties[].valuesarray<object>Yes
properties[].values[].valuestringYes
properties[].values[].countintegerYes

Example response:

{
  "name": "purchase",
  "properties": [
    {
      "type": "örnek",
      "key": "key-2026-10",
      "values": [
        {
          "value": "user_42",
          "count": 1
        }
      ]
    }
  ],
  "id": "def_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "display_name": "örnek",
  "properties_schema": {
    "key": "user_42"
  },
  "is_conversion": true,
  "outcome_unique": true,
  "outcome_unattributed": true,
  "retention_days": 1,
  "first_seen_at": "örnek",
  "last_seen_at": "örnek",
  "count_30d": 1,
  "created_at": "örnek",
  "updated_at": "örnek",
  "daily": [
    {
      "date": "örnek",
      "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/events/definitions/Sipariş bildirimleri" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Display name / conversion flag

PATCH/v1/apps/{appId}/events/definitions/{name}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
namepathstringYes"Sipariş bildirimleri"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: PatchEventDefinitionDto

FieldTypeRequiredDescription
display_namestring | nullNo
is_conversionbooleanNo
outcome_uniquebooleanNo
outcome_unattributedbooleanNo
retention_daysinteger | nullNo

Example:

{
  "display_name": "örnek",
  "is_conversion": true,
  "outcome_unique": true,
  "outcome_unattributed": true,
  "retention_days": 1
}

Responses

200 — Success.

Schema: EventDefinition

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
display_namestring | nullYes
properties_schemamap<string, string>Yes
is_conversionbooleanYes
outcome_uniquebooleanYes
outcome_unattributedbooleanYes
retention_daysinteger | nullYes
first_seen_atstringYes
last_seen_atstringYes
count_30dintegerYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "purchase",
  "id": "def_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "display_name": "örnek",
  "properties_schema": {
    "key": "user_42"
  },
  "is_conversion": true,
  "outcome_unique": true,
  "outcome_unattributed": true,
  "retention_days": 1,
  "first_seen_at": "örnek",
  "last_seen_at": "örnek",
  "count_30d": 1,
  "created_at": "örnek",
  "updated_at": "örnek"
}

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

Examples

curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/events/definitions/Sipariş bildirimleri" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "display_name": "örnek",
  "is_conversion": true,
  "outcome_unique": true,
  "outcome_unattributed": true,
  "retention_days": 1
}'

Recent events (with user ID and properties; name and time filters)

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

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

Parameters

NameInTypeRequiredDescriptionExample
namequerystringNoLength: 1–100"Sipariş bildirimleri"
limitqueryintegerNoDefault: 100; Range: 1–20050
sincequerystring (date-time)No"2026-10-17T09:00:00Z"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: RecentEvents

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].user_idstring | nullYes
data[].subscription_idstring | nullYes
data[].namestringYes
data[].propertiesmap<string, any>Yes
data[].valuenumber | nullYes
data[].sourceenumYesValues: "sdk", "api", "system", "import"
data[].occurred_atstringYes

Example response:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "properties": {
        "order_id": "1001"
      },
      "id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "value": 149.9,
      "source": "sdk",
      "occurred_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/events/recent?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

On this page