API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/reports/revenue

ark.get_revenue_report

Returns permissioned revenue, expense, margin, load-count, trend, category, and entity report data.

Availability

Expanded preview

Scopes

reports:read

ARK permissions

canViewReportscanViewRevenueReport

Team visibility

Required and enforced

Idempotency-Key

Not required

Approval

No MCP approval on REST API-token calls

Rate limit

API credential and organization budgets

Parameters

fromquerystringrequired

toquerystringrequired

team_idsquerystring

Comma-separated visible team IDs. Omit to use every team available to the credential.

load_statusquerystring

Comma-separated load statuses. Defaults to Pending, Dispatched, and Delivered.

customer_idquerystring

sales_rep_idquerystring

broker_idquerystring

carrier_idquerystring

origin_cityquerystring

origin_statequerystring

destination_cityquerystring

destination_statequerystring

load_sizequerystring

trailerquerystring

date_filter_typequerystring

one of: delivery_date, created_date, booking_date, pickup_date; default: "delivery_date"

customer_currencyquerystring

one of: USD, CAD, MXN

carrier_currencyquerystring

one of: USD, CAD, MXN

intervalquerystring

one of: hour, day, week, month; default: "day"

timezonequerystring

IANA timezone used for trend buckets.

include_detailsqueryboolean

include_trendsqueryboolean

include_entitiesqueryboolean

Request body

None.

Example request

curl 'https://arktms.com/api/v1/reports/revenue?from=<from>&to=<to>' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

Report result

Errors

HTTP 400

Invalid request

HTTP 401

Authentication required

HTTP 403

Permission, scope, team, or entitlement denied