API Logs

The client.ApiLogs sub-client provides read-only access to notification API log entries. An API log entry is created for every call to the send notification endpoint and records the full lifecycle of that request: receipt, queuing, processing, and final outcome.

API logs are useful for auditing, debugging failed requests, and monitoring throughput.

Available methods

What is logged

Each API log entry captures:

• The full request payload sent to the send endpoint
• Transaction ID, application, region, language, notification type/subtype
• Source of the request (CPaaS or API)
• Client IP address and HTTP method
• Processing status and status detail
• Timing information: when received, queued, and completed
• Total processing duration in milliseconds
• Number of messages created, succeeded, and failed
• Status change history

API log response model

ApiLogResponse fields:

NotificationApiLogStatus enum

Listing API logs

using OneSend2U.Sdk.ApiLogs.Models;

var list = await client.ApiLogs.GetListAsync(new GetApiLogsRequest
{
    SkipCount      = 0,
    MaxResultCount = 50
});

Console.WriteLine($"Total: {list.TotalCount}");

foreach (var log in list.Items)
{
    Console.WriteLine(
        $"[{log.ReceivedAt:O}] {log.TransactionId} — {log.Status} — {log.DurationMs}ms");
}

Getting an API log by ID

var log = await client.ApiLogs.GetAsync(logId);

Console.WriteLine($"Transaction ID:  {log.TransactionId}");
Console.WriteLine($"Status:          {log.Status}");
Console.WriteLine($"Received:        {log.ReceivedAt:O}");
Console.WriteLine($"Completed:       {log.CompletedAt:O}");
Console.WriteLine($"Duration:        {log.DurationMs}ms");
Console.WriteLine($"Messages OK:     {log.MessagesSuccess}");
Console.WriteLine($"Messages Error:  {log.MessagesError}");

foreach (var entry in log.StatusHistory)
    Console.WriteLine($"  [{entry.Timestamp:O}] {entry.Status} — {entry.StatusDetail}  (source: {entry.Source})");

Filtering by date range

var list = await client.ApiLogs.GetListAsync(new GetApiLogsRequest
{
    SkipCount       = 0,
    MaxResultCount  = 100,
    Status          = NotificationApiLogStatus.Error,
    ReceivedAtMin   = DateTime.UtcNow.AddDays(-1),
    ReceivedAtMax   = DateTime.UtcNow,
    Sorting         = "ReceivedAt desc"
});

Pagination

const int pageSize = 50;
int skip = 0;
long total;

do
{
    var page = await client.ApiLogs.GetListAsync(new GetApiLogsRequest
    {
        SkipCount      = skip,
        MaxResultCount = pageSize
    });

    total = page.TotalCount;

    foreach (var log in page.Items)
        Console.WriteLine($"{log.TransactionId} — {log.Status}");

    skip += pageSize;
}
while (skip < total);