Skip to main content
GET
/
api
/
v1
/
:team_slug
/
:app_slug
/
orders
/
metrics
Error
A valid request URL is required to generate request examples
{
  "data": {
    "daily_metrics": [
      {
        "day": "<string>",
        "order_count": 123,
        "sales_by_currency": [
          {
            "currency_code": "<string>",
            "total_compensated_sales": 123,
            "total_sales_amount": 123
          }
        ]
      }
    ],
    "hourly_metrics": [
      {
        "hour": "<string>",
        "order_count": 123,
        "sales_by_currency": [
          {
            "currency_code": "<string>",
            "total_compensated_sales": 123,
            "total_sales_amount": 123
          }
        ]
      }
    ],
    "total_order_count": 123,
    "total_sales_by_currency": [
      {
        "currency_code": "<string>",
        "total_compensated_sales": 123,
        "total_sales_amount": 123
      }
    ]
  },
  "details": [
    "<string>"
  ],
  "success": true
}

Path Parameters

​
app_slug
string
required

App slug

​
team_slug
string
required

Team slug

Query Parameters

​
start_date
string
required

Start date (YYYY-MM-DD)

​
end_date
string
required

End date (YYYY-MM-DD)

​
granularity
string

Granularity of the metrics (hour, day)

Response

Sales metrics with order counts retrieved successfully

​
data
object
​
details
string[]

Other information which can be relative to the response. This field is used to give additional information then the main data we want to return. For instance if a product do not match the publishing rules will the product status be set to Incomplete and this field will include why

​
success
boolean