Counts NotificationChannels for several filters at once.

POST /api/notifications/channels/list/continuation/summary-counts deprecated

Requires: Notifications.Channels, merchant scope.

Runs each named filter variant against a shared base filter and returns one count per variant in a single request. This is what fills the summary boxes above a list, such as All, Succeeded and Failed. The counts are approximate in the same way as the single count endpoint, so treat them as display figures rather than reconciliation totals.

Try this in the console

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 SummaryCountsRequest. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/notifications/channels/list/continuation/summary-counts" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "summaryFilters": {},
  "baseFilter": {}
}'

PowerShell

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

$body = @'
{
  "summaryFilters": {},
  "baseFilter": {}
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/notifications/channels/list/continuation/summary-counts' `
    -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.notificationsGetSummaryCountsChannelsListContinuation({
  "summaryFilters": {},
  "baseFilter": {}
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/notifications/channels/list/continuation/summary-counts', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "summaryFilters": {},
    "baseFilter": {}
  }),
});

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<SummaryCountsRequest>("""
    {
      "summaryFilters": {},
      "baseFilter": {}
    }
    """);

var result = await api.NotificationsGetSummaryCountsChannelsListContinuationAsync(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/channels/list/continuation/summary-counts");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "summaryFilters": {},
      "baseFilter": {}
    }
    """, 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.SummaryCountsRequest.from_dict({
      "summaryFilters": {},
      "baseFilter": {}
    })
    result = api.notifications_get_summary_counts_channels_list_continuation(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "summaryFilters": {},
  "baseFilter": {}
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/notifications/channels/list/continuation/summary-counts",
    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
`summaryFilters` required	object	Dictionary mapping summary keys (e.g., "succeeded", "failed") to their filter definitions. Null values mean "no additional filter" (count all matching the base filter). nullable
`baseFilter` required	all of FilterGroup	Optional filter from other active layers (tabs, chips) that is AND-merged with each summary filter before counting.

This request body has no documented fields.