CLcleverpush
Notifications

GetChannelNotifications

Get notifications

get/channel/{id}/notifications

Request

  • Base URL
    https://api.cleverpush.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

idstring required

The channel id

Query parameters

limitstring

How many notifications to get. Default: 50. Maximum: 5000

offsetstring

How many notifications to skip. Default: 0

noTransactionalstring

Does not output notifications which were tagged as 'transactional'

statusstring

Shows all notifications if not set. Possible values: 'sent', 'sending', 'scheduled', 'queued', 'failed'

externalIdstring[]

Include only notifications which match the specified externalId. The external ID can be provided in the /notification/send endpoint. (can be array of external IDs or string)

topicsstring[]

Include only notifications which match the specified topics. (can be array of topics or string)

startDatestring

Start date UNIX timestamp (seconds), reflects to queuedAt field

endDatestring

End date UNIX timestamp (seconds), reflects to queuedAt field

fieldsstring

Comma-separated list of fields to include in the response (sparse fieldsets). When omitted, the full object is returned (default, unchanged behavior). Unknown fields are ignored; _id is always included. Example: fields=_id,title,sent. Selectable fields: _id, title, text, channel, user, source, url, autoHide, socialSharingActions, createdAt, expiresAt, expiresAtHours, iconUrl, subscriptionCount, sent, optOuts, delivered, clicked, hidden, jobId, queuedAt, status, subscriptionStatistics, actions.

Response

Success-Response:

Changes

No recorded changes to this operation across all 3 revisions of this API.