Skip to main content
GET
/
logs
cURL
curl "https://api.arkhq.io/v1/logs?status=error&perPage=10" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "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": null,
        "queryParams": null
      },
      "sdk": {
        "name": "ark-python",
        "version": "1.0.0"
      },
      "credential": {
        "id": "cred_abc123",
        "keyPrefix": "ak_live_"
      },
      "email": {
        "id": "aBc123XyZ",
        "recipientCount": 1
      },
      "rateLimit": {
        "limited": false,
        "limit": 10,
        "remaining": 9,
        "reset": 1705312260
      }
    }
  ],
  "page": 1,
  "perPage": 50,
  "total": 150,
  "totalPages": 3,
  "meta": {
    "requestId": "req_xyz789"
  }
}

Documentation Index

Fetch the complete documentation index at: https://arkhq.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Authorization: Bearer YOUR_API_KEY

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
perPage
integer
default:50

Results per page (max 100)

Required range: 1 <= x <= 100
​
requestId
string

Filter by request ID (partial match)

​
status
enum<string>

Filter by status category:

  • success - Status codes < 400
  • error - Status codes >= 400
Available options:
success,
error
​
statusCode
integer

Filter by exact HTTP status code (100-599)

Required range: 100 <= x <= 599
​
endpoint
string

Filter by endpoint name

​
credentialId
string

Filter by API credential ID

​
startDate
string<date-time>

Filter logs after this date (ISO 8601 format)

​
endDate
string<date-time>

Filter logs before this date (ISO 8601 format)

Response

List of API request logs

Paginated list of API request logs

​
data
object[]
required

Array of log entries

​
page
integer
required

Current page number

Example:

1

​
perPage
integer
required

Items per page

Example:

50

​
total
integer
required

Total number of logs matching the query

Example:

150

​
totalPages
integer
required

Total pages available

Example:

3

​
meta
object
required