Skip to content
Products
/
/
/
A21 - Get shop statistics

A21 - Get shop statistics

Request

Call Frequency
Recommended usage: Once per day
Maximum usage: Once per day
Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_SHOP_READ)
Query
periodsstring

List of periods using a comma (,) as a separator. Accepted values are ALL_SINCE_BEGINNING, LAST_MONTH, LAST_THREE_MONTHS, LAST_SIX_MONTHS, LAST_YEAR. If specified, only statistics for the given periods will be returned. If not, all statistics will be returned.

channel_codestring

The code of the channel to filter statistics on. If not specified, the overall statistics will be returned.

shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/account/statistics?periods=string&channel_code=string&shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
approval_delayArray of objects

The average time period (in seconds) between when an order notification is sent to the shop and when the order is accepted.

approval_rateArray of objects

The number of accepted order lines divided by the total number of accepted and rejected order lines.

auto_refused_rateArray of objects

The number of automatically rejected order lines divided by the total number of order lines submitted for approval.

average_cartArray of objects

Total of accepted order sales amount (tax included) divided by total accepted orders.

average_cart_with_shippingArray of objects

Total of accepted order sales amount (tax included) with shipping divided by total accepted orders.

cancelation_rateArray of objects

The number of accepted order lines with at least one cancelation divided by the total number of accepted order lines.

channelstring

Channel code. If no channel is specified in the query params, this field is null

consecutive_refused_orders_countArray of objects

Number of consecutive orders refused by the shop. Only present when the channelCode filter is not present.

evaluations_countArray of objects

Number of shop evaluations

gradeArray of objects

Global grade of the shop

incident_rateArray of objects

The number of order lines with at least one incident divided by the total number of accepted order lines.

last_updated_datestring, (date-time)

Date and time when these statistics were last calculated.

late_shipment_rateArray of objects

The number of orders shipped later than the shipping deadline divided by the total number of orders.

offers_countArray of objects

Total count of active offers of the shop. Only present when the channelCode filter is not present.

order_messages_response_delayArray of objects

The average time period (in seconds) in which the shop responds to a customer's order-related message.

orders_countArray of objects

Total count of debited orders. Includes accepted orders for Pay on Delivery payment method.

refund_rateArray of objects

The number of order lines with at least one refund divided by the total number of accepted order lines.

return_rateArray of objects

The number of order lines with at least one return divided by the total number of returnable order lines.

shipping_delayArray of objects

The average time period (in seconds) in which an order with the "Awaiting shipment" status is shipped.

shop_idinteger, (int64)

The identifier of the shop

total_revenueArray of objects

Total shop revenue

valid_tracking_rateArray of objects

The number of orders with a valid tracking divided by the total number of orders minus orders having an uncovered shipment. Return null if Mirakl Delivery Manager is not activated

Response
{
  "approval_delay": [
    { … }
  ],
  "approval_rate": [
    { … }
  ],
  "auto_refused_rate": [
    { … }
  ],
  "average_cart": [
    { … }
  ],
  "average_cart_with_shipping": [
    { … }
  ],
  "cancelation_rate": [
    { … }
  ],
  "channel": "string",
  "consecutive_refused_orders_count": [
    { … }
  ],
  "evaluations_count": [
    { … }
  ],
  "grade": [
    { … }
  ],
  "incident_rate": [
    { … }
  ],
  "last_updated_date": "2023-03-28T09:34:42Z",
  "late_shipment_rate": [
    { … }
  ],
  "offers_count": [
    { … }
  ],
  "order_messages_response_delay": [
    { … }
  ],
  "orders_count": [
    { … }
  ],
  "refund_rate": [
    { … }
  ],
  "return_rate": [
    { … }
  ],
  "shipping_delay": [
    { … }
  ],
  "shop_id": 0,
  "total_revenue": [
    { … }
  ],
  "valid_tracking_rate": [
    { … }
  ]
}