Skip to main content
GET
/
logs
/
{requestId}
cURL
curl "https://api.arkhq.io/v1/logs/req_V8GGcdWYzgeWIHiI" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "success": true,
  "data": {
    "requestId": "req_V8GGcdWYzgeWIHiI",
    "timestamp": "2024-01-15T10:30:00Z",
    "method": "POST",
    "path": "/v1/emails",
    "endpoint": "emails.send",
    "statusCode": 200,
    "durationMs": 145,
    "error": null,
    "context": {
      "ipAddress": "192.168.1.1",
      "userAgent": "ark-python/1.0.0",
      "idempotencyKey": "unique-key-123",
      "queryParams": null
    },
    "sdk": {
      "name": "ark-python",
      "version": "1.0.0"
    },
    "credential": {
      "id": "cred_abc123",
      "keyPrefix": "ak_live_"
    },
    "request": {
      "bodySize": 256,
      "body": {
        "tenantId": "cm6abc123def456",
        "from": "hello@example.com",
        "to": [
          "user@example.com"
        ],
        "subject": "Hello World",
        "html": "<h1>Welcome!</h1>"
      }
    },
    "response": {
      "bodySize": 128,
      "body": {
        "success": true,
        "data": {
          "id": "aBc123XyZ",
          "tenantId": "cm6abc123def456",
          "messageId": "<abc@mail.arkhq.io>",
          "status": "pending"
        }
      }
    },
    "rateLimit": {
      "limited": false,
      "limit": 10,
      "remaining": 9,
      "reset": 1705312260
    },
    "email": {
      "id": "aBc123XyZ",
      "recipientCount": 1
    }
  },
  "meta": {
    "requestId": "req_xyz789"
  }
}

Authorizations

Authorization
string
header
required

Use your API key from arkhq.io/org/credentials

Authorization: Bearer YOUR_API_KEY

Path Parameters

requestId
string
required

The request ID (format req_*)

Pattern: ^req_

Response

API request log details

Detailed API request log with request/response bodies

success
boolean
required
data
object
required

Full API request log entry with bodies

meta
object
required