ARK TMS

MCP documentation | MCP docs for agents

ark_get_revenue_report

ark.get_revenue_report

Return permissioned revenue, expense, margin, load-count, trend, category, and entity report data for a date range and visible teams.

Availability
Expanded preview
Scopes
reports:read
ARK permissions
canViewReportscanViewRevenueReport
Team visibility
Required and enforced
Approval policy
none
ARK approval request
Not required
Idempotency
Not required
Read-only
Yes
Destructive
No
External side effect
No
Rate limit
OAuth MCP credential and organization budgets

Input

fromstringrequired

Inclusive report start date in YYYY-MM-DD format.

tostringrequired

Inclusive report end date in YYYY-MM-DD format.

teamIdsarray<string>

Optional visible team IDs. Omit to use all teams available to the connection.

min items: 1; max items: 100

loadStatusarray<string>

default: ["Pending","Dispatched","Delivered"]; max items: 50

customerIdstring

format: uuid

salesRepIdstring

format: uuid

brokerIdstring

format: uuid

carrierIdstring

format: uuid

originCitystring

min length: 1; max length: 100

originStatestring

min length: 1; max length: 50

destinationCitystring

min length: 1; max length: 100

destinationStatestring

min length: 1; max length: 50

loadSizestring

min length: 1; max length: 50

trailerstring

min length: 1; max length: 100

dateFilterTypestring

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

customerCurrencystring

one of: USD, CAD, MXN

carrierCurrencystring

one of: USD, CAD, MXN

intervalstring

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

timezonestring

IANA timezone used for trend bucket boundaries.

default: "UTC"; min length: 1; max length: 100

includeDetailsboolean

default: true

includeTrendsboolean

default: true

includeEntitiesboolean

default: true

Result

The tool returns the canonical ark.get_revenue_report operation result in structuredContent and mirrors the same JSON as text. Errors set isError: true and return a stable error code, message, and optional details.