Widget Analytics
Retrieve per-widget performance metrics with pagination, sorting, and type filtering. Get analytics for all widgets or a specific widget by ID.
Authorization
BearerAuth 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 of the date range (ISO 8601). Defaults to 30 days ago.
dateEnd of the date range (ISO 8601). Defaults to now.
datePage number (1-indexed).
11 <= valueResults per page (max 100).
101 <= value <= 100Field to sort results by.
"views""views" | "clicks" | "impressions" | "add_to_cart" | "orders" | "revenue" | "title" | "created_at"Sort direction.
"desc""asc" | "desc"Filter by widget type.
"carousel" | "story" | "floating" | "productpage"Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://production.reelplus.app/api/v1/analytics/widgets"{
"success": true,
"data": [
{
"id": "widget-xyz789",
"title": "Home Carousel",
"type": "carousel",
"status": "active",
"video_count": 8,
"metrics": {
"impressions": 5600,
"views": 1450,
"clicks": 195,
"add_to_cart": 42,
"orders": 12,
"revenue": 967.8
}
}
],
"meta": {
"start_date": "2025-01-01T00:00:00.000Z",
"end_date": "2025-01-31T23:59:59.999Z"
},
"pagination": {
"page": 1,
"limit": 10,
"total_count": 42,
"total_pages": 5
}
}{
"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."
}
}Authorization
BearerAuth 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
Path Parameters
The unique widget identifier.
Query Parameters
Start of the date range (ISO 8601). Defaults to 30 days ago.
dateEnd of the date range (ISO 8601). Defaults to now.
dateResponse Body
application/json
application/json
application/json
application/json
curl -X GET "https://production.reelplus.app/api/v1/analytics/widget/widget-xyz789"{
"success": true,
"data": {
"id": "widget-xyz789",
"title": "Home Carousel",
"type": "carousel",
"status": "active",
"video_count": 8,
"metrics": {
"impressions": 5600,
"views": 1450,
"clicks": 195,
"add_to_cart": 42,
"orders": 12,
"revenue": 967.8
}
},
"meta": {
"start_date": "2025-01-01T00:00:00.000Z",
"end_date": "2025-01-31T23:59:59.999Z"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Missing or invalid Authorization header. Use: Authorization: Bearer rp_xxx"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
}
}{
"success": false,
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests. Please retry after 42 seconds."
}
}