Reporting engagement

Many channels keep track of top-of-funnel metrics like views, shares, comments, and likes. Your new channel can send this data to the merchant's Shopify store. This allows the merchant to view your channel's engagement data in their reports. Engagement data is specific to a given day (in UTC). If you send engagement data more than once for the same day then the last transmission will overwrite the engagement data that was sent before it. (Properties that are omitted or set to null will not overwrite any previous engagement data that has been stored for a given day.)

  • POST /admin/apps/$app_id/products/channel_engagements.json
    Send engagement data to Shopify for a specified product and UTC day. The required properties are product_id and occurred_on. Optional properties are: impressions_count, views_count, favorites_count, shares_count and comments_count.

Sample request to report engagement on a product

POST /admin/apps/2329148/products/channel_engagements.json HTTP/1.1
X-Shopify-Access-Token: 085abas8bd90325c3f81s8e9c88befc0
Content-Type: application/json

  "channel_engagements": [
      "product_id": 6858979,
      "occurred_on": "2015-09-02",
      "impressions_count": 30,
      "views_count": 20,
      "favorites_count": 14,
      "shares_count": null,
      "ad_spend": 10.50,
      "comments_count": 2,
      "referred_order_value": 50.20,
      "referred_order_count": 2

View Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Shopify-Shop-Api-Call-Limit: 1/40