Counts how deliveries ended in a time window, broken down by outcome.

POST /api/notifications/deliveries/outcome-summary deprecated

Requires: Notifications.Deliveries, merchant scope.

This is drop accounting for an outage: how many events were still queued, how many were skipped without an outbound attempt because the destination was suppressed, and how many exhausted their retries and were dead-lettered, over the period a receiver was unreachable. It counts in the store and reads no delivery, so the answer costs the same whether the window holds ten deliveries or ten thousand. The window is bounded, and a wider one is refused rather than quietly narrowed: an answer silently covering a quarter of what was asked for would look exactly like a merchant who sent nothing for the rest of it. Count a longer period in steps. A POST because the window and its narrowing are a request body, matching the other continuation and summary reads in this platform. Nothing is created or changed.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a GetNotificationDeliveryOutcomeSummaryInput. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/notifications/deliveries/outcome-summary" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "fromUtc": "2026-01-01T00:00:00Z",
  "toUtc": "2026-01-01T00:00:00Z"
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "fromUtc": "2026-01-01T00:00:00Z",
  "toUtc": "2026-01-01T00:00:00Z"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/notifications/deliveries/outcome-summary' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, NotificationsApi } from '@winkpg/winkpg-api';

const api = new NotificationsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.notificationsGetDeliveryOutcomeSummary({
  "fromUtc": "2026-01-01T00:00:00Z",
  "toUtc": "2026-01-01T00:00:00Z"
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/notifications/deliveries/outcome-summary', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "fromUtc": "2026-01-01T00:00:00Z",
    "toUtc": "2026-01-01T00:00:00Z"
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new NotificationsApi(config);
var body = JsonSerializer.Deserialize<GetNotificationDeliveryOutcomeSummaryInput>("""
    {
      "fromUtc": "2026-01-01T00:00:00Z",
      "toUtc": "2026-01-01T00:00:00Z"
    }
    """);

var result = await api.NotificationsGetDeliveryOutcomeSummaryAsync(body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/notifications/deliveries/outcome-summary");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "fromUtc": "2026-01-01T00:00:00Z",
      "toUtc": "2026-01-01T00:00:00Z"
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.NotificationsApi(client)
    body = winkpg_api.GetNotificationDeliveryOutcomeSummaryInput.from_dict({
      "fromUtc": "2026-01-01T00:00:00Z",
      "toUtc": "2026-01-01T00:00:00Z"
    })
    result = api.notifications_get_delivery_outcome_summary(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "fromUtc": "2026-01-01T00:00:00Z",
  "toUtc": "2026-01-01T00:00:00Z"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/notifications/deliveries/outcome-summary",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`fromUtc` required	string (date-time)	Start of the window, inclusive, in UTC.
`toUtc` required	string (date-time)	End of the window, exclusive, in UTC.
`merchantId` required	string (uuid)	Count only this merchant's deliveries, or every merchant the caller's operating context already reaches when omitted. nullable
`eventType` required	string	Count only this exact event type, or every type when omitted. nullablemax length 512

This request body has no documented fields.

Responses

200 The count of deliveries in each state, plus the window they cover.

Body: NotificationDeliveryOutcomeSummaryDto Each item has these fields.

Field	Type	Description
`fromUtc` required	string (date-time)	Start of the counted window, inclusive, in UTC.
`toUtc` required	string (date-time)	End of the counted window, exclusive, in UTC.
`pending` required	integer (int64)	Deliveries created but not yet picked up by a processor: still queued on this side.
`processing` required	integer (int64)	Deliveries in flight when the window was counted.
`succeeded` required	integer (int64)	Deliveries the destination acknowledged. The "delivered" number.
`failed` required	integer (int64)	Deliveries that failed an attempt and may still be retried.
`deadLettered` required	integer (int64)	Deliveries that exhausted every retry and were dead-lettered.
`skipped` required	integer (int64)	Deliveries never attempted, because the destination was suppressed or another policy gate stopped them. The closest thing this platform has to "discarded".
`total` required	integer (int64)	Every delivery in the window, in any state. read only

This response has no documented body fields.

400 The window is missing, inverted, or wider than the bound.

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

This response has no documented body fields.

403 The caller may not read delivery history.

Body: Each item has these fields.

Field	Type	Description

This response has no body.

default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

This response has no documented body fields.

429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Notifications

The API reference isn't available right now

No such operation

This reference may be out of date

Counts how deliveries ended in a time window, broken down by outcome.

Example request

Parameters

Request body

Responses

200 The count of deliveries in each state, plus the window they cover.

400 The window is missing, inverted, or wider than the bound.

403 The caller may not read delivery history.

Errors

Authentication