Sign in

v49

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-02-185890337.1 KB
Logs

List API request logs

Retrieve a paginated list of API request logs for debugging and monitoring. Results are ordered by timestamp, newest first.

Use cases:

  • Debug integration issues by reviewing recent requests
  • Monitor error rates and response times
  • Audit API usage patterns

Filters:

  • status - Filter by success or error category
  • statusCode - Filter by exact HTTP status code
  • endpoint - Filter by endpoint name (e.g., emails.send)
  • credentialId - Filter by API key
  • startDate/endDate - Filter by date range

Note: Request and response bodies are only included when retrieving a single log entry with GET /logs/{requestId}.

Related endpoints:

  • GET /logs/{requestId} - Get full log details with request/response bodies
get/logs

Query parameters

pageinteger

Page number

perPageinteger

Results per page (max 100)

requestIdstring

Filter by request ID (partial match)

status'success' | 'error'

Filter by status category:

  • success - Status codes < 400
  • error - Status codes >= 400
statusCodeinteger

Filter by exact HTTP status code (100-599)

endpointstring

Filter by endpoint name

credentialIdstring

Filter by API credential ID

startDatestring date-time

Filter logs after this date (ISO 8601 format)

endDatestring date-time

Filter logs before this date (ISO 8601 format)

Response

List of API request logs

pageinteger required

Current page number

perPageinteger required

Items per page

totalinteger required

Total number of logs matching the query

totalPagesinteger required

Total pages available

Example response

{
  "data": [
    {
      "requestId": "req_V8GGcdWYzgeWIHiI",
      "timestamp": "2024-01-15T10:30:00Z",
      "method": "POST",
      "path": "/v1/emails",
      "endpoint": "emails.send",
      "statusCode": 200,
      "durationMs": 145,
      "error": {
        "code": "validation_error",
        "message": "The 'to' field must contain valid email addresses"
      },
      "context": {
        "ipAddress": "192.168.1.1",
        "userAgent": "ark-python/1.0.0",
        "idempotencyKey": "unique-key-123"
      },
      "sdk": {
        "name": "ark-python",
        "version": "1.0.0"
      },
      "credential": {
        "id": "cred_abc123",
        "keyPrefix": "ak_live_"
      },
      "email": {
        "id": "aBc123XyZ",
        "recipientCount": 1
      },
      "rateLimit": {
        "limit": 5,
        "remaining": 4,
        "reset": 1705312260
      }
    }
  ],
  "page": 1,
  "perPage": 50,
  "total": 150,
  "totalPages": 3,
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}