Get Orders Chart (Date Range)
GET/api/starshipit/integration-instances/:integration_instance/orders-chart
Returns a daily order-count time series for a StarShipIt integration instance over the given date range.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
The response contains one bucket per day in [start_date, end_date], filling zero-counts for days with no orders. Used by the dashboard chart to render the orders trend.
Query parameters:
- start_date (required, YYYY-MM-DD): start of the range
- end_date (required, YYYY-MM-DD): end of the range; must be >= start_date
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.