API documentation | API docs for agents | OpenAPI 3.1

exports

ark.request_audit_export

Creates a permissioned audit export request for a bounded date range and selected audit filters.

Availability: Expanded preview
Scopes: audit:export
ARK permissions: canViewAuditTimelinecanExportAuditLog
Team visibility: Not entity-scoped
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 200

Request body

reasonstringrequired

min length: 1; max length: 500

viewstring

one of: activity, security, payments, integrations, exports, diagnostics; default: "activity"

domainViewstring

one of: load.case_file, load.spot_quote_funnel, load.carrier_award, load.dispatch_exceptions, load.load_board, load.tracking, carrier.trust, carrier.onboarding, carrier.payment_risk, carrier.compliance_documents, carrier.provider_monitoring, carrier.rejections_dnu, finance.payment_ledger, finance.ap_settlement, finance.ar_invoice_payment, finance.nacha, finance.quickbooks, finance.pay_holds, finance.report_snapshots, integration.edi_trace, integration.tracking_visibility, integration.settings, evidence.documents, evidence.pod_review, customer.account, customer.locations, people.activity, admin.security, admin.org_config, admin.internal_tools, audit.exports, audit.operations

qstring

min length: 1; max length: 200

fromstringrequired

format: date-time

tostringrequired

format: date-time

subjectTypestring

max length: 100

subjectIdstring

max length: 200

actorUserIdstring

format: uuid

actorTypestring

max length: 100

eventKeystring

max length: 200

eventFamilystring

max length: 100

visibilityClassstring

one of: business, security, admin, operational

sourcestring

max length: 100

providerstring

max length: 100

correlationIdstring

max length: 200

transactionIdstring

idempotencyKeystring

max length: 200

requestIdstring

max length: 200

teamIdstring

format: uuid

formatstring

one of: json, csv; default: "json"

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/audit/exports' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "<reason>",
  "from": "2026-07-16T14:00:00Z",
  "to": "2026-07-16T14:00:00Z"
}'

Success response

Audit export request queued

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.exportIdstringrequired

format: uuid

data.statusstringrequired

data.formatstringrequired

one of: json, csv

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 409: Idempotency conflict or in-progress retry