Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get order metrics

Returns aggregated sales metrics for the requested range.

GET/api/v2/{team_slug}/{app_slug}/orders/metrics
Authorization
AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters
team_slugstringrequired
app_slugstringrequired
Query parameters
granularitystring
Allowed:hourday
start-datestring<date-time>
end-datestring<date-time>
currency-codestring[]

Repeatable currency code filter

Responses
200

OK

dataOrderMetricsrequired
Show properties
hourly_metricsOrderHourlyMetric[]
Show properties
Array of OrderHourlyMetric
hourstring<date-time>required
order_countintegerrequired
sales_by_currencyOrderSalesByCurrency[] | null
daily_metricsOrderDailyMetric[]
Show properties
Array of OrderDailyMetric
daystring<date-time>required
order_countintegerrequired
sales_by_currencyOrderSalesByCurrency[] | null
total_order_countinteger
total_sales_by_currencyOrderSalesByCurrency[] | null
Show properties
Array of OrderSalesByCurrency
currency_codestringrequired
total_sales_amountnumberrequired
total_compensated_salesnumberrequired
400

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
401

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
403

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
500

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.enad.io/api/v2/string/string/orders/metrics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "hourly_metrics": [
      {
        "hour": "2019-08-24T14:15:22Z",
        "order_count": 0,
        "sales_by_currency": [
          {
            "currency_code": "string",
            "total_sales_amount": 0,
            "total_compensated_sales": 0
          }
        ]
      }
    ],
    "daily_metrics": [
      {
        "day": "2019-08-24T14:15:22Z",
        "order_count": 0,
        "sales_by_currency": [
          {
            "currency_code": "string",
            "total_sales_amount": 0,
            "total_compensated_sales": 0
          }
        ]
      }
    ],
    "total_order_count": 0,
    "total_sales_by_currency": [
      {
        "currency_code": "string",
        "total_sales_amount": 0,
        "total_compensated_sales": 0
      }
    ]
  }
}