Analytics

Get Product Movers

Changed on

Retrieves the products whose revenue moved the most against the preceding window of the same length.

get/v1/shops/{shopId}/analytics/product-movers

Request

Query parameters

directionstring

Whether to return the biggest fallers or the biggest gainers. One of decliners, risers.

Example:decliners
limitinteger

How many products to return, up to 10.

Example:5

Response

product_idinteger
product_namestring
total_revenue_usdnumber
previous_revenue_usdinteger
revenue_change_usdnumber
revenue_change_pctinteger
unitsinteger
previous_unitsinteger

Example response

[
  {
    "product_id": 1,
    "product_name": "License Keys",
    "total_revenue_usd": 44.97,
    "previous_revenue_usd": 0,
    "revenue_change_usd": 44.97,
    "revenue_change_pct": 4497,
    "units": 3,
    "previous_units": 0,
    "images": []
  }
]

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      endpoint added