Get Product Summary
Product
Get Product Summary
/product/summary
GET
Get Product Summary
This endpoint requires authentication. Include your Bearer token in the Authorization header.
Description
/product/summary Description: The/product/summary endpoint retrieves aggregated statistics for all products in a tenant, including counts by status, format, and type, plus revenue data from ProductStats.
Role-Based Access:
- Admin/Owner: See summary for all products in the tenant
- Other Users: See summary only for products associated with their artists
GET
Response Data:
| Field | Type | Description |
|---|---|---|
| total | integer | Total number of products |
| byStatus | object | Count of products by status (Live, Taken Down, Scheduled, Pending, Error) |
| byFormat | object | Count of products by format (Single, EP, Album, LP) |
| byType | object | Count of products by type (Audio, Video, Ringtone) |
| revenue.totalCount | integer | Total count/streams from ProductStats |
| revenue.totalRoyalty | number | Total royalty amount from ProductStats |
| Parameter | Type | Description |
|---|---|---|
| startDate (Optional) | string | Filter products created from this date (inclusive) |
| endDate (Optional) | string | Filter products created to this date (inclusive) |
| status (Optional) | string | Filter by product status |
| format (Optional) | string | Filter by product format |
| type (Optional) | string | Filter by product type |
Code Examples
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Query Parameters
Filter products created from this date (inclusive)
Filter products created to this date (inclusive)
Filter by product status
Available options:
Live, Taken Down, Scheduled, Pending, Error Filter by product format
Available options:
Single, EP, Album, LP Filter by product type
Available options:
Audio, Video, Ringtone