API ReferenceAnalytics Summary
Analytics Summary
Retrieve aggregated analytics metrics for your entire store including impressions, views, clicks, add-to-cart events, orders, and revenue.
Authorization
BearerAuth AuthorizationBearer <token>
API key with rp_ prefix. Generate from Settings > API Access in your ReelPlus dashboard.
Format: rp_{64 hex characters}
Example: rp_your_api_key_here
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.
Format
dateend_date?string
End of the date range in ISO 8601 format (e.g. 2025-01-31). Defaults to now.
Format
dateResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://production.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": "INVALID_DATE",
"message": "Invalid date format. Use ISO 8601: YYYY-MM-DD"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Missing or invalid Authorization header. Use: Authorization: Bearer rp_xxx"
}
}{
"success": false,
"error": {
"code": "INVALID_API_KEY",
"message": "Invalid or revoked API key"
}
}{
"success": false,
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests. Please retry after 42 seconds."
}
}