ePost Communication Platform Monitoring

Get monitoring data for the deliveries.

get/epost/deliveries/monitoring

Request

  • Base URL: https://api.klara.ch
  • URL: https://api.klara.ch/epost/deliveries/monitoring
  • Auth: one of:
    • API key in header X-API-KEY
    • HTTP bearer

Query parameters

delivery-idinteger

Filter <b>recipient tracking</b> base on the delivery id.<br/>If this parameter is empty, the API will return the records for all deliveries.

limitinteger

Define the limit of the <b>recipient tracking</b> list that this API returns.<br/>For example, if a sender have 10 <b>recipient tracking</b> in the database, and this limit parameter is 5, and the offset parameter is 0,<br/>then this API will return the list containing the first 5 records<br/>If not set, then default value of 48 is used

offsetinteger

Define which position to start getting <b>recipient tracking</b> list.<br/>For example, if a user have 10 <b>recipient tracking</b> in the database, and this offset parameter is 5,<br/>then this API will return <b>recipient tracking</b> list from the 5th record.<br/>If not set, then default value of 0 is used

sort'DESCENDING' | 'ASCENDING'

Sorting the list for getting newest (DESC) or oldest (ASC) results.

Response

List of recipient tracking was returned

idinteger
deliveryIdinteger
deliveredTimestring date-time
createdTimestring date-time
costCenterstring
documentTitlestring
documentTypesDocumentType[]
senderUserIdstring
costnumber
channelstring
statusstring
thirdPartyStatusstring
thirdPartyErrorMessagestring
errorCodestring
deliveryChannelPreferencesDeliveryChannelPreference[]
pricePlanstring

Example response

[
  {
    "unhashedCredentials": {
      "universalName": "KLARA Business AG / Peter Muster",
      "firstName": "Peter",
      "lastName": "Muster",
      "companyName": "KLARA",
      "companyUid": "CHE-123.456.789",
      "street": "Bahnhofstrasse 10a",
      "streetNumber": "20",
      "zipCode": "3000",
      "city": "Bern",
      "email": "peter.muster@gmail.com",
      "mobileNumber": " +41909112233",
      "birthDate": "1990-01-02",
      "socialSecurityNumber": "756.1234.5678.97",
      "taxId": "263125",
      "postOfficeBoxNumber": "12",
      "postOfficeBoxZip": "1212",
      "postOfficeBoxTownName": "Vervey 1",
      "unstructuredAddressLine01": "Peter Muster",
      "unstructuredAddressLine02": "Bahnhofsstr 20",
      "unstructuredAddressLine03": "8004 Zurich Switzerland",
      "billRecipientId": "41010560425610173"
    },
    "detail": {
      "documentMetadata": {
        "ebillAdditionalInfo": {
          "dueDate": "2022-12-22",
          "paymentAmount": 20,
          "qrReference": "RF012345QF67T8910UI123"
        },
        "emailAdditionalInfo": {
          "emailText": "Hello world.",
          "emailHtml": "<html><h1>Hallo world</h1><br><img src=\"cid:picture1.png\"/></html>",
          "emailSubject": "your invoice from KLARA",
          "sender": {
            "email": "abc@klara.ch",
            "name": "ABC"
          },
          "replyTo": [
            {
              "email": "abc@klara.ch",
              "name": "ABC"
            }
          ],
          "cc": [
            {
              "email": "abc@klara.ch",
              "name": "ABC"
            }
          ],
          "bcc": [
            {
              "email": "abc@klara.ch",
              "name": "ABC"
            }
          ],
          "inlineImages": [
            {
              "filename": "picture1.png",
              "base64": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAXCAYAAAD+4+QTAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQ"
            }
          ]
        },
        "digitalAdditionalInfo": {
          "digitalDeliveryVariant": "STANDARD"
        }
      }
    },
    "businessStatusHistory": [
      {
        "businessStatus": "DELIVERED",
        "changedAt": "2023-11-14T22:13:20Z",
        "triggeredByUserFirstName": "John",
        "triggeredByUserLastName": "Doe"
      }
    ],
    "effectiveILetterParameters": [
      {
        "key": "claimId",
        "value": "CLM-2026-0042"
      }
    ],
    "effectiveILetterPlaceholders": [
      {
        "key": "claimNumber",
        "value": "CLM-2026-000471"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.