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
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/events/definitions | Event 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/recent | Recent events (with user ID and properties; name and time filters) |
Details
Event definitions
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
limit | query | integer | No | Default: 500; Range: 1–500 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: EventDefinitionList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].display_name | string | null | Yes | |
data[].properties_schema | map<string, string> | Yes | |
data[].is_conversion | boolean | Yes | |
data[].outcome_unique | boolean | Yes | |
data[].outcome_unattributed | boolean | Yes | |
data[].retention_days | integer | null | Yes | |
data[].first_seen_at | string | Yes | |
data[].last_seen_at | string | Yes | |
data[].count_30d | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
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
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
name | path | string | Yes | "Sipariş bildirimleri" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: EventDefinitionDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
display_name | string | null | Yes | |
properties_schema | map<string, string> | Yes | |
is_conversion | boolean | Yes | |
outcome_unique | boolean | Yes | |
outcome_unattributed | boolean | Yes | |
retention_days | integer | null | Yes | |
first_seen_at | string | Yes | |
last_seen_at | string | Yes | |
count_30d | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
daily | array<object> | Yes | |
daily[].date | string | Yes | |
daily[].count | integer | Yes | |
daily[].users | integer | Yes | |
properties | array<object> | Yes | |
properties[].key | string | Yes | |
properties[].type | string | Yes | |
properties[].values | array<object> | Yes | |
properties[].values[].value | string | Yes | |
properties[].values[].count | integer | Yes |
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
Authentication: API key — scope events:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
name | path | string | Yes | "Sipariş bildirimleri" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: PatchEventDefinitionDto
| Field | Type | Required | Description |
|---|---|---|---|
display_name | string | null | No | |
is_conversion | boolean | No | |
outcome_unique | boolean | No | |
outcome_unattributed | boolean | No | |
retention_days | integer | null | No |
Example:
{
"display_name": "örnek",
"is_conversion": true,
"outcome_unique": true,
"outcome_unattributed": true,
"retention_days": 1
}Responses
200 — Success.
Schema: EventDefinition
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
display_name | string | null | Yes | |
properties_schema | map<string, string> | Yes | |
is_conversion | boolean | Yes | |
outcome_unique | boolean | Yes | |
outcome_unattributed | boolean | Yes | |
retention_days | integer | null | Yes | |
first_seen_at | string | Yes | |
last_seen_at | string | Yes | |
count_30d | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
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)
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
name | query | string | No | Length: 1–100 | "Sipariş bildirimleri" |
limit | query | integer | No | Default: 100; Range: 1–200 | 50 |
since | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: RecentEvents
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].subscription_id | string | null | Yes | |
data[].name | string | Yes | |
data[].properties | map<string, any> | Yes | |
data[].value | number | null | Yes | |
data[].source | enum | Yes | Values: "sdk", "api", "system", "import" |
data[].occurred_at | string | Yes |
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"Users and subscriptions
Users and subscriptions — 35 operations (GET /v1/apps/{appId}/companies, POST /v1/apps/{appId}/companies, POST /v1/apps/{appId}/companies/batch, …). Generated from the OpenAPI 3.1.0 contract.
Segments
Segments — 34 operations (GET /v1/apps/{appId}/geofences, POST /v1/apps/{appId}/geofences, GET /v1/apps/{appId}/geofences/{geofenceId}, …). Generated from the OpenAPI 3.1.0 contract.