Analytics Summary

The whole funnel for the store in one call, from widget impressions to attributed revenue, for any date range.


One call, one object: everything ReelPlus recorded for the store in the date range, already added up. This is the endpoint behind a "ReelPlus this month" tile on a dashboard, or a daily row in a spreadsheet.

Reading the numbers

The eight fields are one funnel, in order. Each step can only be reached through the one before it.

FieldWhat it counts
impressionsA widget was loaded on a page.
viewsA video started playing.
clicksA shopper clicked a product inside a video.
add_to_cartA product was added to the cart from a video.
ordersOrders attributed to a video interaction.
revenueThe value of those orders, in the store currency.
ctrClick-through rate: clicks / views × 100.
cvrConversion rate: orders / views × 100.

Rates are percentages with 2 decimals. When views is 0, both rates are 0.

Date range

start_date and end_date take YYYY-MM-DD or a full ISO 8601 timestamp. Without them you get the last 30 days. The range you actually got back is echoed in meta, so a dashboard can label the tile correctly.

The sandbox demo store carries 120 days of data. A range outside it returns zeros, not an error.

Try it

curl "https://help.reelplus.app/api/v1/analytics/summary?start_date=2026-10-01&end_date=2026-10-28" \
  -H "Authorization: Bearer rp_653f0a33f2bbf185566e8e9a11651a4fd3cfc5fe10c1694eef4d54b830c2d2cf"

Or press Send below. The playground already points at the sandbox and carries the demo key in the Authorization field.

GET
/api/v1/analytics/summary

Authorization

BearerAuth
AuthorizationBearer <token>

API key with the rp_ prefix, sent as a Bearer token.

Sandbox: use the demo key from the API Overview. It is read-only and limited to the demo store.

Production: keys are issued per store on Enterprise plans, on request. Once enabled, generate them from Settings > API Access in your ReelPlus dashboard.

Format: rp_{64 hex characters}

In: header

Query Parameters

start_date?string

Start of the date range in ISO 8601 format (e.g. 2025-01-01). Defaults to 30 days ago.

Formatdate
end_date?string

End of the date range in ISO 8601 format (e.g. 2025-01-31). Defaults to now.

Formatdate

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://help.reelplus.app/api/v1/analytics/summary"
{
  "success": true,
  "data": {
    "impressions": 12450,
    "views": 3280,
    "clicks": 412,
    "add_to_cart": 87,
    "orders": 23,
    "revenue": 1847.5,
    "ctr": 12.56,
    "cvr": 0.7
  },
  "meta": {
    "start_date": "2025-01-01T00:00:00.000Z",
    "end_date": "2025-01-31T23:59:59.999Z"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}