CHchrt
/analytics
/shipping

Retrieve (via POST) order count

Retrieves order counts bucketed by time period. | (AnalyticsTimePeriodReq) -> (AnalyticsTimeBucketRes)

post/analytics/shipping/orders/count/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/analytics/shipping/orders/count/v1
  • Auth
    HTTP bearer

Request body

startstring date-time required
endstring date-time required
granularity'hour' | 'day' | 'week' | 'month' | 'year'
timezone'America/Los_Angeles' | 'America/Denver' | 'America/Chicago' | 'America/New_York' | 'America/Anchorage' | 'Pacific/Honolulu' | 'Europe/London' | 'Europe/Paris' | 'Europe/Berlin' | 'Europe/Amsterdam' | 'Europe/Rome' | 'Europe/Madrid' | 'Europe/Zurich' | 'Europe/Stockholm' | 'Europe/Warsaw' | 'Europe/Athens' | 'UTC'
start_of_week'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'

Response

Successful Response

totalnumber required

Changes

No recorded changes to this operation across all 20 revisions of this API.