# Metadata

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/reporting/metadata:
    post:
      summary: Metadata
      deprecated: false
      description: ''
      tags:
        - API Reference/Reporting API
      parameters:
        - 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-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}}'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                report:
                  type: string
              required:
                - report
              x-apidog-orders:
                - report
            example:
              report: members_grouped_count
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  description:
                    type: string
                  aggregate_by:
                    type: object
                    properties:
                      by_grouping_type_and_value:
                        type: object
                        properties:
                          sort_by:
                            type: array
                            items:
                              type: string
                        required:
                          - sort_by
                        x-apidog-orders:
                          - sort_by
                    required:
                      - by_grouping_type_and_value
                    x-apidog-orders:
                      - by_grouping_type_and_value
                  fields:
                    type: object
                    properties:
                      loyalty_club_id:
                        type: object
                        properties:
                          type:
                            type: string
                        required:
                          - type
                        x-apidog-orders:
                          - type
                      grouping_type:
                        type: object
                        properties:
                          type:
                            type: string
                          possible_values:
                            type: array
                            items:
                              type: string
                        required:
                          - type
                          - possible_values
                        x-apidog-orders:
                          - type
                          - possible_values
                      grouping_value:
                        type: object
                        properties:
                          type:
                            type: string
                        required:
                          - type
                        x-apidog-orders:
                          - type
                    required:
                      - loyalty_club_id
                      - grouping_type
                      - grouping_value
                    x-apidog-orders:
                      - loyalty_club_id
                      - grouping_type
                      - grouping_value
                  result_type:
                    type: string
                  sort_by:
                    type: array
                    items:
                      type: string
                required:
                  - description
                  - aggregate_by
                  - fields
                  - result_type
                  - sort_by
                x-apidog-orders:
                  - description
                  - aggregate_by
                  - fields
                  - result_type
                  - sort_by
              example:
                description: >-
                  Fetch current (grouped by type and values) number of members
                  in loyalty clubs
                aggregate_by:
                  by_grouping_type_and_value:
                    sort_by:
                      - grouping_type
                fields:
                  loyalty_club_id:
                    type: integer
                  grouping_type:
                    type: enum
                    possible_values:
                      - optin_channel
                      - optin_subchannel
                      - optin_platform
                      - birth_year_group
                      - consent_true
                      - consent_false
                      - marketing_true
                      - marketing_false
                      - subunit_id
                      - group_id
                      - favorite_store
                      - country
                      - gender
                  grouping_value:
                    type: text
                result_type: records
                sort_by:
                  - loyalty_club_id
                  - grouping_type
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: API Reference/Reporting API
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3574517-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```