Skip to content

Analytics

Contents 26 pages

The analytics report the web app's Analytics page and the Shopify app's Analytics page draw, from the same figures: shipments and spend in a window against the window before it, period by period, the on-time and cost figures, each carrier's scorecard, and the services, lanes and states you shipped. Reading needs analytics:read.

Organizations and Shopify stores alike. Lanes run state to state, and a store's report has no members (it is null).

Read the report#

GET/api/v1/analyticsScope analytics:read
Request
curl "https://app.shipeasyco.com/api/v1/analytics?range=90d&time_zone=America/Chicago" \
  -H "Authorization: Bearer $SHIPEASY_API_KEY"
Response
{
	"object": "analytics_report",
	"status": "populated",
	"window": {
		"range": "90d",
		"label": "13 weeks",
		"first_day": "2026-08-21",
		"last_day": "2026-11-19",
		"unit": "week",
		"time_zone": "America/Chicago",
		"start": "2026-08-21T05:00:00.000Z",
		"end": "2026-11-19T18:00:00.000Z",
		"prior_start": "2026-05-22T05:00:00.000Z",
		"prior_end": "2026-08-21T05:00:00.000Z"
	},
	"kpis": {
		"shipments": { "value": 42, "change": { "previous": 35, "abs": 7, "pct": 20 } },
		"booked_usd": { "value": 18450.5, "change": null },
		"on_time_rate": { "value": 0.93, "n": 38, "change": null }
	},
	"periods": [],
	"first_booking_day": "2026-03-02",
	"carriers": [],
	"services": [],
	"lanes": [],
	"states": [],
	"conversion": { "requests": 51, "converted": 42, "open": 3, "rate": 0.82 },
	"members": null
}

kpis.in_transit and kpis.awaiting_pickup are right now, not the window: freight picked up and moving, and freight booked whose pickup the carrier has not reported yet.

range is 30d (the default), 90d, 12m, or custom with from and to as YYYY-MM-DD. time_zone is the IANA zone whose calendar days the periods are; it defaults to UTC. A rate or an average resting on too few shipments is null, with n saying how many it had. The example leaves the lists empty and most figures out.

Download the CSV#

GET/api/v1/analytics/exportScope analytics:read

The same report, section by section, as the CSV the analytics pages download. It takes the same parameters. In an AI app, get_analytics and export_analytics (AI agents).