Get a push delivery timeline

GET https://z.u1v.ru/api/v1/push/delivery-timeline

Return a filtered delivery timeline for support diagnostics.

Usage examples

curl

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.

curl -sSX GET -G https://z.u1v.ru/api/v1/push/delivery-timeline \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode user_id=42 \
    --data-urlencode server_id=zulip-prod-1 \
    --data-urlencode realm_id=42 \
    --data-urlencode app_brand_id=universalchat \
    --data-urlencode route_id=17 \
    --data-urlencode provider=fcm \
    --data-urlencode token_type=fcm \
    --data-urlencode call_id=call-1 \
    --data-urlencode delivery_trace_id=trace-1 \
    --data-urlencode device_instance_id=device-1 \
    --data-urlencode event_type=call_invite \
    --data-urlencode limit=10

Parameters

user_id integer required

Example: 42

User whose delivery timeline should be returned.

server_id string | null optional

Example: "zulip-prod-1"

Optional logical server filter.

realm_id string | null optional

Example: "42"

Optional organization filter.

app_brand_id string | null optional

Example: "universalchat"

Optional application brand filter.

route_id integer | null optional

Example: 17

Optional push route filter.

provider string | null optional

Example: "fcm"

Optional provider filter.

token_type string | null optional

Example: "fcm"

Optional token type filter.

call_id string | null optional

Example: "call-1"

Optional call identifier filter.

delivery_trace_id string | null optional

Example: "trace-1"

Optional delivery trace filter.

device_instance_id string | null optional

Example: "device-1"

Optional application device filter.

event_type string | null optional

Example: "call_invite"

Optional push event type filter.

limit integer optional

Example: 10

Maximum number of timeline records.

Response

Example response(s)

Successful response from a UCS extension endpoint. Endpoint-specific fields are returned alongside the standard Zulip success envelope.

{
    "msg": "",
    "result": "success"
}

API documentation home

Messages

Scheduled messages

Message reminders

Drafts

Navigation views

Channels

Users

Invitations

Server & organizations

Real-time events

Interactive bots

Specialty endpoints

Back to Zulip

Get a push delivery timeline

Usage examples

Parameters

Response

Example response(s)