TAtalon
Logs

List message log entries

Changed on

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Retrieve all message log entries.

get/v1/message_logs

Request

Query parameters

messageIDstring

Filter results by message ID.

changeType'CampaignEvaluationTreeChanged' | 'CampaignNotification' | 'CouponCreated' | 'CouponUpdated' | 'CouponDeleted' | 'AsyncCouponsCreated' | 'CouponsDeleted' | 'CouponsUpdated' | 'CouponCodeExpiring' | 'StrikethroughPrice' | 'LoyaltyPointsAdded' | 'LoyaltyPointsDeducted' | 'LoyaltyPointsExpiring' | 'LoyaltyPointsPendingToActive' | 'LoyaltyAddedDeductedPointsBalances' | 'LoyaltyCardAddedDeductedPointsBalances' | 'TierWillDowngrade' | 'TierUpgrade' | 'TierDowngrade' | 'LoyaltyCardPointsAdded' | 'LoyaltyCardPointsDeducted' | 'LoyaltyCardPointsExpiring'

Filter results by change type.

notificationIDsstring

Filter results by notification ID (include up to 30 values, separated by a comma).

createdBeforestring date-time

Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. Use UTC time.

createdAfterstring date-time

Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. Use UTC time.

cursorstring byte

A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.

pageSizeinteger

The maximum number of message log entries to return.

period'15m' | '30m' | '1h' | '4h' | '1d' | '2d'

Filter results by time period. Choose between the available relative time frames.

isSuccessfulboolean

Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set totrue, only log entries with 2xx response codes are returned. When set to false, only log entries with 4xx and 5xx response codes are returned.

entityType'application' | 'loyalty_program' | 'webhook' required

The entity type the log is related to.

applicationIdnumber

Filter results by Application ID.

campaignIdnumber

Filter results by campaign ID.

loyaltyProgramIdinteger

Identifier of the loyalty program.

responseCodeinteger

Filter results by response status code.

webhookIDsstring

Filter results by webhook ID (include up to 30 values, separated by a comma).

Response

OK

nextCursorstring byte

The next value in the database.

Note: If this value is not present, it means that there are no more values in the database for this combination of request parameters.

Example response

{
  "nextCursor": "SmJlNERRMHdyNWFsTmRDZDVYU0c=",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "service": "NotificationService",
      "changeType": "Update",
      "notificationId": 101,
      "notificationName": "My campaign notification",
      "webhookId": 101,
      "webhookName": "My webhook",
      "request": {
        "createdAt": "2021-07-20T21:59:00Z",
        "request": "SGVsbG8sIHdvcmxkIQ=="
      },
      "response": {
        "createdAt": "2021-07-20T22:00:50Z",
        "response": "UmVzcG9uc2UgY29udGVudA==",
        "status": 200
      },
      "createdAt": "2021-07-20T22:00:00Z",
      "entityType": "loyalty_program",
      "url": "www.my-company.com/my-endpoint-name",
      "applicationId": 5,
      "loyaltyProgramId": 2,
      "campaignId": 2
    }
  ]
}

Changes