Retrieve (via POST) order count

import { ChrtClient, ChrtEnvironment } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        environment: ChrtEnvironment.Local,
        token: "YOUR_TOKEN_HERE",
    });
    await client.analytics.shipping.retrieveOrdersCountV1({
        start: "2024-01-01T00:00:00Z",
        end: "2024-01-31T23:59:59Z",
    });
}
main();

{
  "buckets": [
    {
      "period": "2024-01-01T00:00:00Z",
      "value": 150
    },
    {
      "period": "2024-01-08T00:00:00Z",
      "value": 175
    },
    {
      "period": "2024-01-15T00:00:00Z",
      "value": 200
    },
    {
      "period": "2024-01-22T00:00:00Z",
      "value": 180
    },
    {
      "period": "2024-01-29T00:00:00Z",
      "value": 195
    }
  ],
  "total": 900
}

Retrieves order counts bucketed by time period. | (AnalyticsTimePeriodRequest) -> (AnalyticsTimeBucketResponse)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

startstringRequiredformat: "date-time"

endstringRequiredformat: "date-time"

granularityenumOptional

Allowed values:

timezoneenumOptional

start_of_weekenum or nullOptional

Response

Successful Response

bucketslist of objects

totaldouble

Authentication

Request

Response

Errors