Admin Reporting: Products
Reporting — products (View Details)
Changed onThe detailed table form of a product stat (the admin "View Details" page). statistics is { columns, records }. ?type= picks the stat group.
get/reporting/products/view
Request
- Base URLhttp://localhost:8000/api/admin
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
type'total-sold-quantities' | 'total-products-added-to-wishlist' | 'top-selling-products-by-revenue' | 'top-selling-products-by-quantity' | 'products-with-most-reviews' | 'last-search-terms' | 'top-search-terms'
Stat group.
startstring date
Start date.
endstring date
End date.
channelstring
Channel code.
Response
AdminReportingProducts collection
Example response
[
{
"statistics": {
"quantities": {
"previous": 82,
"current": 13,
"progress": -84.15
},
"over_time": {
"previous": [
{
"label": "10 Apr",
"total": 21
}
],
"current": [
{
"label": "10 May",
"total": 5
}
]
}
}
}
]Changes
- breaking
removed the enum value
products-with-most-visitsfrom thequeryrequest parametertype
- breaking