Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
ExplorePublic APIManagement APIUsers APIOperations API
Messaging APIReporting APIML APIData API
ExplorePublic APIManagement APIUsers APIOperations API
Messaging APIReporting APIML APIData API
  1. Revenue Reporting
  • Introduction
  • Manager API
    • Introduction
    • Settings
      • Introduction
      • Show Operations Settings
      • Update Settings
    • ABM Links
      • List ABM Links
      • Show Unassigned ABM Links Count
      • Import ABM Links
    • Members
      • Show Contact
      • Delete Contact
      • Update Contact
    • Issues
      • Introduction
      • Reopen Issue
      • List Issue Types
      • List Issues
      • Show Issue
      • Accept Issue
      • Resolve Issue
    • Articles
      • Introduction
      • List Articles
      • Show Article
      • Create Article
      • Update Article
      • Destroy Article
    • Articles Categories
      • Introduction
      • List Categories
      • Show Category
      • Create Category
      • Update Category
      • Destroy Category
      • List Categories with Articles
    • Documents
      • Introduction
      • List Documents
      • Show Document
      • List Document Recipients
      • Create Document
      • Update Document
      • Add Recipients to the Document
      • Destroy Document
    • Resource Types
      • Introduction
      • Show Resource Type Schema
      • Update Resource Type Schema
    • Resources
      • Introduction
      • Delete Resource
      • List Resources
      • Show Resource
      • Accept Resource
      • Reject Resource
      • Create a Resource Reminder
    • Revenue Reporting
      • Introduction
      • List Store Tax Categories
        GET
      • Bulk Update Store Tax Categories
        PUT
      • List Aggregated Reports
        GET
      • List Aggregated Reports As Csv
        GET
      • Show Policy
        GET
      • Update Policy
        PUT
      • List Tax Categories
        GET
      • Bulk Update Tax Categories
        PUT
      • Download revenue reports import template
        GET
      • Import revenue reports from file
        POST
    • Alerts
      • Introduction
      • Recall Alert
      • Deactivate Alert
      • List Alerts
      • Show Alert
      • List Alert Recipients
      • Create Alert
      • Accept Alert
      • Reject Alert
    • Alert Templates
      • Introduction
      • List Alert Templates
      • Show Alert Template
      • Create Alert Template
      • Update Alert Template
      • Destroy Alert Template
    • Footfall Reporting
      • List Footfall Reports
      • Bulk Update Reports
  • Tenant API
    • Introduction
    • Documents
      • Introduction
      • List Documents
      • Show Document
      • Confirm Document
    • Resource Types
      • Show Resource Type Schema
    • Resources
      • Introduction
      • List Resources
      • List Deleted Resources
      • Show Resource
      • Create Resource
      • Update Resource
      • Destroy Resource
      • Resubmit Resource
      • Restore Resource
    • Alerts
      • Introduction
      • List Alert Types
      • List Alerts
      • Show Alert
      • Create Alert
      • Report to Alert
    • Alert Templates
      • List Alert Templates
    • Push App Tokens
      • Introduction
      • Add App Tokens
    • Revenue Reporting
      • List Reporting Periods
      • List Reporting Period Reports
      • Bulk Update Reports
      • List Tax Categories
      • List Store Tax Categories
      • Bulk Update
    • ABM Links
      • Assign ABM Link
      • Send ABM Link
    • Issues
      • Introduction
      • List Issues
      • Show Issue
      • Create Issue
      • Update Issues
      • Destroy Issue
    • Articles
      • Introduction
      • List Articles
      • Show Article
      • List Categories with Articles
  1. Revenue Reporting

List Aggregated Reports

GET
https://api.mpc.dev.placewise.com/v1/operations/revenue_reporting/reports/aggregated
API Permit:Operations:Api:RevenueReportingTaxCategories:List
API Context:Loyalty Club
Authorizations:UserToken
Returns reports data aggregated (grouped) by given subject and subperiods within given time period.
It is possible to group reports by following subjects:
store
floor - no. of floor the store is located at
zone - name of store zone
category - store category
day - day of the report

Request

Query Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C#
Ruby
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/operations/revenue_reporting/reports/aggregated?subject&date_from=2025-06-10&date_to=2025-06-10&complete&category&floor&zone&store_id&tax_category_id&sort_by&sort_direction' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: '

Responses

🟢200Success
application/json
Body

Example
{
    "total": {
        "name": "Mr. Salvador Kerluke I",
        "current": {
            "value_cents": {
                "sum": 99258185,
                "avg": 0.4426408797715915,
                "per_area": 0.39423893139673216,
                "ocr": 1499133.4464572072
            },
            "transaction_count": {
                "sum": null,
                "avg": 0.35303254971383324,
                "per_area": 0.16978327787857173
            },
            "last_updated_at": "2025-06-10T09:34:31.210Z",
            "last_user_id": "656e67fe-5c11-4252-8810-1344ac6202ef",
            "complete": false
        },
        "previous": null,
        "growth": {
            "value_cents": {
                "sum": 8660823,
                "avg": 0.953788713465012,
                "per_area": 0.6594079406592187,
                "ocr": null
            },
            "transaction_count": {
                "sum": 73258238,
                "avg": 0.4551306549166281,
                "per_area": 0.8065769002266552
            }
        }
    },
    "subperiods": [
        {
            "name": "Guillermo Hilll",
            "current": {
                "value_cents": {
                    "sum": null,
                    "avg": 0.764809275612569,
                    "per_area": 0.09316831709573059,
                    "ocr": -54789842.85131698
                },
                "transaction_count": {
                    "sum": null,
                    "avg": 0.847757781537513,
                    "per_area": 0.8786094297020535
                },
                "last_updated_at": "2025-06-10T09:34:31.220Z",
                "last_user_id": "488b0a22-ca3f-4c15-890e-4389207c301d",
                "complete": false
            },
            "previous": null,
            "growth": {
                "value_cents": {
                    "sum": 15122861,
                    "avg": 0.6324351909341789,
                    "per_area": 0.2669045495838782,
                    "ocr": null
                },
                "transaction_count": {
                    "sum": 14732596,
                    "avg": 0.572167096459677,
                    "per_area": 0.7919155582123425
                }
            }
        },
        {
            "name": "Amy Mosciski",
            "current": {
                "value_cents": {
                    "sum": null,
                    "avg": 0.8729065447594931,
                    "per_area": 0.3965030282232196,
                    "ocr": -52159121.64441434
                },
                "transaction_count": {
                    "sum": 33404168,
                    "avg": 0.45822699634174857,
                    "per_area": 0.0198150365705142
                },
                "last_updated_at": "2025-06-10T09:34:31.225Z",
                "last_user_id": "604602ae-bc2d-42b1-aac9-3a5e944b728a",
                "complete": true
            },
            "previous": null,
            "growth": {
                "value_cents": {
                    "sum": 3535865,
                    "avg": 0.8807606451393575,
                    "per_area": 0.24942504490758788,
                    "ocr": 59231362.225504845
                },
                "transaction_count": {
                    "sum": null,
                    "avg": 0.6292607714449909,
                    "per_area": 0.8065487495232555
                }
            }
        },
        {
            "name": "Nick Collier",
            "current": {
                "value_cents": {
                    "sum": 54331509,
                    "avg": 0.7155247107126536,
                    "per_area": 0.21528238166566682,
                    "ocr": null
                },
                "transaction_count": {
                    "sum": null,
                    "avg": 0.06158914431503926,
                    "per_area": 0.22538412572003552
                },
                "last_updated_at": "2025-06-10T09:34:31.230Z",
                "last_user_id": "f97bc6c4-e048-4cad-8e4c-085fdce519e7",
                "complete": true
            },
            "previous": null,
            "growth": {
                "value_cents": {
                    "sum": 2615133,
                    "avg": 0.8059106567685659,
                    "per_area": 0.6941004394497209,
                    "ocr": -20030554.68089643
                },
                "transaction_count": {
                    "sum": null,
                    "avg": 0.25729463854811985,
                    "per_area": 0.6749604003484615
                }
            }
        }
    ],
    "subjects": [
        {
            "name": "Angie Goodwin DVM",
            "current": {
                "value_cents": {
                    "sum": 45540956,
                    "avg": 0.42371734805914285,
                    "per_area": 0.10853674631510213,
                    "ocr": -99152215.19471118
                },
                "transaction_count": {
                    "sum": 4799669,
                    "avg": 0.7293819125807025,
                    "per_area": 0.6440690861293489
                },
                "last_updated_at": "2025-06-10T09:34:31.236Z",
                "last_user_id": "e8c3f687-1fd8-4175-864b-460978338607",
                "complete": true
            },
            "previous": {
                "value_cents": {
                    "sum": 19069185,
                    "avg": 0.0817417115125092,
                    "per_area": 0.9403090549338909,
                    "ocr": 28809025.70002544
                },
                "transaction_count": {
                    "sum": null,
                    "avg": 0.966320020589174,
                    "per_area": 0.9574799840363665
                },
                "last_updated_at": "2025-06-10T09:34:31.237Z",
                "last_user_id": "d306eb8f-3877-4241-9a23-a736ca046cba",
                "complete": true
            },
            "growth": {
                "value_cents": {
                    "sum": null,
                    "avg": 0.2447663718368116,
                    "per_area": 0.4925622248627112,
                    "ocr": -45090356.63520054
                },
                "transaction_count": {
                    "sum": null,
                    "avg": 0.32641802028277833,
                    "per_area": 0.44631441464304655
                }
            }
        },
        {
            "name": "Ronnie Reynolds",
            "current": {
                "value_cents": {
                    "sum": 45863495,
                    "avg": 0.4477786373295811,
                    "per_area": 0.8795868030876925,
                    "ocr": null
                },
                "transaction_count": {
                    "sum": 90738978,
                    "avg": 0.9878139903047418,
                    "per_area": 0.529358423357583
                },
                "last_updated_at": "2025-06-10T09:34:31.254Z",
                "last_user_id": "9e6536c5-17f6-46fb-82e3-07adabc4f613",
                "complete": true
            },
            "previous": null,
            "growth": {
                "value_cents": {
                    "sum": null,
                    "avg": 0.07325178488077322,
                    "per_area": 0.1900194331559869,
                    "ocr": null
                },
                "transaction_count": {
                    "sum": 8125066,
                    "avg": 0.6404042778698674,
                    "per_area": 0.9671424430282509
                }
            }
        },
        {
            "name": "Tyler Senger",
            "current": {
                "value_cents": {
                    "sum": null,
                    "avg": 0.925681611668349,
                    "per_area": 0.8483681633485136,
                    "ocr": null
                },
                "transaction_count": {
                    "sum": null,
                    "avg": 0.8468791036412568,
                    "per_area": 0.2524755671729485
                },
                "last_updated_at": "2025-06-10T09:34:31.258Z",
                "last_user_id": "3c6b8306-40cb-44c5-8fac-c29c7d7fe74e",
                "complete": false
            },
            "previous": {
                "value_cents": {
                    "sum": 22809706,
                    "avg": 0.8926791894751802,
                    "per_area": 0.6740750457156113,
                    "ocr": null
                },
                "transaction_count": {
                    "sum": 72366945,
                    "avg": 0.3841743907802584,
                    "per_area": 0.5623760929508111
                },
                "last_updated_at": "2025-06-10T09:34:31.260Z",
                "last_user_id": "3216000f-f456-4a77-8d3a-eec64527068d",
                "complete": true
            },
            "growth": {
                "value_cents": {
                    "sum": null,
                    "avg": 0.7342112202965687,
                    "per_area": 0.19710534400024826,
                    "ocr": null
                },
                "transaction_count": {
                    "sum": 49643575,
                    "avg": 0.21751597404848677,
                    "per_area": 0.9341444742809665
                }
            }
        }
    ],
    "meta": {
        "subject": "qui dolor",
        "period_available": {
            "starts_at": "2025-06-10",
            "ends_at": "2025-06-10"
        },
        "period_selected": {
            "type": "week",
            "current": {
                "starts_at": "2025-06-10",
                "ends_at": "2025-06-10",
                "definition": {
                    "year": 2020,
                    "week": 13,
                    "iso8601_number": "22"
                }
            },
            "previous": null
        }
    }
}
🟠422Invalid Parameters
Previous
Bulk Update Store Tax Categories
Next
List Aggregated Reports As Csv
Built with