DEdepop
Insights

Get shop insights

This endpoint returns insights about the authenticated seller's shop, including product counts, shop rating, offers awaiting review, boost ad counts and orders awaiting shipping.

Required OAuth Scopes: at least one of the scopes below. Each section of the response is included only when its corresponding scope is present, and omitted otherwise. A 403 is returned only when none of these scopes are present.

  • products_read - Include product counts (products) and boost ad counts (boost). - shop_read - Include shop rating (rating). - offers_read - Include offers awaiting seller review (offers). - orders_read - Include orders awaiting shipping (orders).

A section is included in the response only when its corresponding scope is present, and is omitted entirely otherwise. A 403 is returned only when the token has none of the four scopes above. Note: Counters may be delayed by up to 60 minutes and may not reflect the most recent changes to your shop inventory.

get/api/v1/insights/shop/live/

Request

Response

Shop insights. Each section is present only when the token holds the scope that section requires; sections for missing scopes are omitted. The orders section is additionally omitted when there are no orders awaiting shipping.

Example response

{
  "products": {
    "on_sale_count": 42,
    "total_count": 150
  },
  "rating": {
    "average": 4.8,
    "count": 120
  },
  "boost": {
    "live_count": 12,
    "sold_count": 34
  },
  "orders": {
    "awaiting_shipping_count": 5
  },
  "offers": {
    "awaiting_seller_review_count": 8
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.