# List Aggregated Reports

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/operations/revenue_reporting/reports/aggregated:
    get:
      summary: List Aggregated Reports
      deprecated: false
      description: >-
        Returns reports data aggregated (grouped) by given subject and
        subperiods within given time period.


        It is possible to group reports by following `subject`s:


        * `store`

        * `floor` - no. of floor the store is located at

        * `zone` - name of store zone

        * `category` - store category

        * `day` - day of the report
      tags:
        - API Reference/Operations API/Manager API/Revenue Reporting
      parameters:
        - name: subject
          in: query
          description: 'enum: store, floor, location, category, day'
          required: true
          schema:
            type: string
            enum:
              - store
              - location
              - floor
              - category
              - day
            x-apidog-enum:
              - value: store
                name: ''
                description: ''
              - value: location
                name: ''
                description: ''
              - value: floor
                name: ''
                description: ''
              - value: category
                name: ''
                description: ''
              - value: day
                name: ''
                description: ''
        - name: date_from
          in: query
          description: Start of the period to query
          required: true
          example: '2025-06-10'
          schema:
            type: string
        - name: date_to
          in: query
          description: End of the period to query
          required: true
          example: '2025-06-10'
          schema:
            type: string
        - name: complete
          in: query
          description: >-
            If true, returns only completed reports. If false, only
            non-completed. When null, returns all
          required: false
          schema:
            type: boolean
        - name: category
          in: query
          description: When given, returns only results for given category
          required: false
          schema:
            type: string
        - name: floor
          in: query
          description: When given, returns only results for given floor
          required: false
          schema:
            type: string
        - name: zone
          in: query
          description: When given, returns only results for given zone
          required: false
          schema:
            type: string
        - name: store_id
          in: query
          description: When given, returns only results for given store
          required: false
          schema:
            type: integer
        - name: tax_category_id
          in: query
          description: When given, returns only results for given tax category
          required: false
          schema:
            type: integer
        - name: sort_by
          in: query
          description: >-
            enum: name, value_cents, value_cents_growth, value_cents_avg,
            value_cents_avg_growth, value_cents_avg_per_area,
            value_cents_avg_per_area_growth, transaction_count,

            transaction_count_growth
          required: false
          schema:
            type: string
        - name: sort_direction
          in: query
          description: 'enum: asc, desc'
          required: false
          schema:
            type: string
        - name: Content-Type
          in: header
          description: '[Details](doc-341635)'
          required: true
          example: application/json
          schema:
            type: string
            default: application/json
            const: application/json
        - name: X-User-Agent
          in: header
          description: Arbitrary identifier of your client. [Details](doc-341635)
          required: true
          example: '{{X_USER_AGENT}}'
          schema:
            type: string
            default: '{{X_USER_AGENT}}'
        - name: X-Product-Name
          in: header
          description: API Product for API context. [Details](doc-341635)
          required: true
          example: '{{PRODUCT_NAME}}'
          schema:
            type: string
            default: '{{PRODUCT_NAME}}'
        - name: X-Loyalty-Club-Slug
          in: header
          description: LoyaltyClub for API context. [Details](doc-342138)
          required: false
          example: '{{LOYALTY_CLUB_SLUG}}'
          schema:
            type: string
            default: '{{LOYALTY_CLUB_SLUG}}'
        - name: X-Customer
          in: header
          description: Customer for API context.  [Details](doc-342139)
          required: false
          example: '{{CUSTOMER_ID}}'
          schema:
            type: string
            default: '{{CUSTOMER_ID}}'
        - name: Authorization
          in: header
          description: '[Member](doc-342129) or [User](doc-342130) Authorization.'
          required: false
          example: Bearer {{_OAUTH_TOKEN}}
          schema:
            type: string
            default: Bearer {{_OAUTH_TOKEN}}
        - name: X-Client-Authorization
          in: header
          description: '[Token](doc-342128) Authorization.'
          example: '{{API_TOKEN}}'
          schema:
            type: string
            default: '{{API_TOKEN}}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                properties:
                  total: &ref_0
                    $ref: '#/components/schemas/RevenueReportingAggregationRecord'
                  subperiods:
                    type: array
                    items: *ref_0
                  subjects:
                    type: array
                    items: *ref_0
                  meta:
                    type: object
                    properties:
                      subject:
                        type: string
                      period_available:
                        type: object
                        properties:
                          starts_at:
                            type: string
                            x-apidog-mock: >-
                              {{$date.isoTimestamp(formattingStyle='basic')|format('yyyy-MM-dd')}}
                            description: >-
                              Start date of range for which the data is
                              available for querying
                          ends_at:
                            type: string
                            x-apidog-mock: '{{$date.isoTimestamp|format(''yyyy-MM-dd'')}}'
                            description: >-
                              End date of range for which the data is available
                              for querying
                        x-apidog-orders:
                          - starts_at
                          - ends_at
                        required:
                          - starts_at
                          - ends_at
                        x-apidog-ignore-properties: []
                      period_selected:
                        type: object
                        properties:
                          type:
                            type: string
                            description: >-
                              enum: year, quarter, month, week, day, custom - 
                              Period detected from selected range
                            enum:
                              - year
                              - quarter
                              - month
                              - week
                              - day
                              - custom
                            x-apidog-enum:
                              - value: year
                                name: ''
                                description: ''
                              - value: quarter
                                name: ''
                                description: ''
                              - value: month
                                name: ''
                                description: ''
                              - value: week
                                name: ''
                                description: ''
                              - value: day
                                name: ''
                                description: ''
                              - value: custom
                                name: ''
                                description: ''
                          current: &ref_1
                            properties:
                              starts_at:
                                type: string
                                x-apidog-mock: '{{$date.isoTimestamp|format(''yyyy-MM-dd'')}}'
                                description: Start date of queried range
                              ends_at:
                                type: string
                                x-apidog-mock: '{{$date.isoTimestamp|format(''yyyy-MM-dd'')}}'
                                description: End date of queried range
                              definition:
                                type: object
                                properties: {}
                                x-apidog-orders: []
                                description: >-
                                  Definition of queried range. Format depends on
                                  recognized `type`
                            x-apidog-orders:
                              - starts_at
                              - ends_at
                              - definition
                            required:
                              - starts_at
                              - ends_at
                              - definition
                            $ref: >-
                              #/components/schemas/RevenueReportingAggregationMetaRange
                          previous:
                            anyOf:
                              - *ref_1
                              - type: 'null'
                        x-apidog-orders:
                          - type
                          - current
                          - previous
                        required:
                          - type
                          - current
                          - previous
                        x-apidog-ignore-properties: []
                    x-apidog-orders:
                      - subject
                      - period_available
                      - period_selected
                    required:
                      - subject
                      - period_available
                      - period_selected
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                  - total
                  - subperiods
                  - subjects
                  - meta
                required:
                  - total
                  - subperiods
                  - subjects
                  - meta
                type: object
                x-apidog-refs: {}
                x-apidog-ignore-properties: []
              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
          headers: {}
          x-apidog-name: Success
        '422':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    examples:
                      - Invalid parameters
                    const: Invalid parameters
                  details:
                    type: object
                    properties: {}
                    x-apidog-orders: []
                    description: 'See: [Params Validation](doc-341637)'
                    additionalProperties: true
                    x-apidog-ignore-properties: []
                required:
                  - error
                  - details
                x-apidog-orders:
                  - error
                  - details
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Invalid Parameters
      security: []
      x-apidog-folder: API Reference/Operations API/Manager API/Revenue Reporting
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3511300-run
components:
  schemas:
    RevenueReportingAggregationMetaRange:
      type: object
      properties:
        starts_at:
          type: string
          x-apidog-mock: '{{$date.isoTimestamp|format(''yyyy-MM-dd'')}}'
          description: Start date of queried range
        ends_at:
          type: string
          x-apidog-mock: '{{$date.isoTimestamp|format(''yyyy-MM-dd'')}}'
          description: End date of queried range
        definition:
          type: object
          properties:
            year:
              type: integer
              description: Part of week type definition
              minimum: 2020
              maximum: 2030
            week:
              type: integer
              description: Part of week type definition
              minimum: 1
              maximum: 53
            iso8601_number:
              type: string
              description: Part of week type - week number according to ISO 8601
            iso8601_year:
              type: integer
              description: >-
                Part of week type - year of the week number according to ISO
                8601
          x-apidog-orders:
            - year
            - week
            - iso8601_number
            - iso8601_year
          description: Definition of queried range. Format depends on recognized `type`
          required:
            - iso8601_year
          x-apidog-ignore-properties: []
      x-apidog-orders:
        - starts_at
        - ends_at
        - definition
      required:
        - starts_at
        - ends_at
        - definition
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    RevenueReportingAggregationRecord:
      type: object
      properties:
        name:
          type: string
        current: &ref_2
          properties:
            value_cents: &ref_3
              $ref: '#/components/schemas/RevenueReportingAggregationResultValues'
              description: Contains aggregations of `value_cents`
            transaction_count: &ref_4
              $ref: >-
                #/components/schemas/RevenueReportingAggregationResultTransactions
              description: Contains aggregations of `transaction_count`
            last_updated_at:
              type: string
              x-apidog-mock: '{{$date.isoTimestamp}}'
              description: Last report update in the grouping
              nullable: true
            last_user_id:
              type: string
              x-apidog-mock: '{{$string.uuid}}'
              description: ID of user that most recently updated report in the grouping
              nullable: true
            complete:
              type: boolean
              description: Are all reports completed?
          x-apidog-orders:
            - value_cents
            - transaction_count
            - last_updated_at
            - last_user_id
            - complete
          required:
            - value_cents
            - transaction_count
            - last_updated_at
            - last_user_id
            - complete
          $ref: '#/components/schemas/RevenueReportingAggregationResult'
        previous:
          anyOf:
            - *ref_2
            - type: 'null'
        growth:
          properties:
            value_cents: *ref_3
            transaction_count: *ref_4
          x-apidog-orders:
            - value_cents
            - transaction_count
          required:
            - value_cents
            - transaction_count
          $ref: '#/components/schemas/RevenueReportingAggregationRecordGrowth'
      x-apidog-orders:
        - name
        - current
        - previous
        - growth
      required:
        - name
        - current
        - growth
      x-apidog-refs: {}
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    RevenueReportingAggregationRecordGrowth:
      type: object
      properties:
        value_cents: *ref_3
        transaction_count: *ref_4
      x-apidog-orders:
        - value_cents
        - transaction_count
      required:
        - value_cents
        - transaction_count
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    RevenueReportingAggregationResultTransactions:
      type: object
      properties:
        sum:
          type: integer
          minimum: 0
          nullable: true
        avg:
          type: number
          minimum: 0
          x-apidog-mock: '{{$number.float}}'
          nullable: true
        per_area:
          type: number
          minimum: 0
          x-apidog-mock: '{{$number.float}}'
          nullable: true
      x-apidog-orders:
        - sum
        - avg
        - per_area
      required:
        - sum
        - avg
        - per_area
      description: Contains aggregations of `transaction_count`
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    RevenueReportingAggregationResultValues:
      type: object
      properties:
        sum:
          type: integer
          minimum: 0
          nullable: true
        avg:
          type: number
          x-apidog-mock: '{{$number.float}}'
          minimum: 0
          nullable: true
        per_area:
          type: number
          x-apidog-mock: '{{$number.float}}'
          minimum: 0
          nullable: true
        ocr:
          type: number
          nullable: true
      x-apidog-orders:
        - sum
        - avg
        - per_area
        - ocr
      required:
        - sum
        - avg
        - per_area
        - ocr
      description: Contains aggregations of `value_cents`
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    RevenueReportingAggregationResult:
      type: object
      properties:
        value_cents: *ref_3
        transaction_count: *ref_4
        last_updated_at:
          type: string
          x-apidog-mock: '{{$date.isoTimestamp}}'
          description: Last report update in the grouping
          nullable: true
        last_user_id:
          type: string
          x-apidog-mock: '{{$string.uuid}}'
          description: ID of user that most recently updated report in the grouping
          nullable: true
        complete:
          type: boolean
          description: Are all reports completed?
      x-apidog-orders:
        - value_cents
        - transaction_count
        - last_updated_at
        - last_user_id
        - complete
      required:
        - value_cents
        - transaction_count
        - last_updated_at
        - last_user_id
        - complete
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```