# Show data transfer summary

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/billing/data_transfer/summary:
    get:
      summary: Show data transfer summary
      deprecated: false
      description: ''
      tags:
        - API Reference/Management API/Core/Billing/Data transfer
      parameters:
        - name: period
          in: query
          description: >-
            Length of period for summary. If provided requires offset param. If
            not provided will return all data for customer.
          required: false
          example: month
          schema:
            type: string
            enum:
              - month
              - year
            x-apidog-enum:
              - name: ''
                value: month
                description: ''
              - name: ''
                value: year
                description: ''
        - name: offset
          in: query
          description: >-
            Offset from the current date in period unit. If provided requires
            period param. 
          required: false
          example: 0
          schema:
            type: integer
            minimum: 0
        - 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:
                type: object
                properties:
                  summary:
                    type: object
                    properties:
                      total: &ref_0
                        $ref: '#/components/schemas/DataTransferBilling'
                      files: *ref_0
                      webforms: *ref_0
                      websites: *ref_0
                      emails: *ref_0
                    required:
                      - total
                      - files
                      - webforms
                      - websites
                      - emails
                    x-apidog-orders:
                      - total
                      - files
                      - webforms
                      - websites
                      - emails
                    x-apidog-ignore-properties: []
                required:
                  - summary
                x-apidog-orders:
                  - summary
                x-apidog-ignore-properties: []
              examples:
                '1':
                  summary: Success
                  value:
                    summary:
                      total:
                        request_bytes: 18600519
                        response_bytes: 63291696
                      files:
                        request_bytes: 55011964
                        response_bytes: 12862838
                      webforms:
                        request_bytes: 23424251
                        response_bytes: 16813423
                      websites:
                        request_bytes: 52430267
                        response_bytes: 62919105
                      emails:
                        request_bytes: 18005896
                        response_bytes: 90895241
                '2':
                  summary: Exception
                  value:
                    error: Invalid parameters
                    details:
                      period:
                        - error: inclusion
                          message: is not included in the list
                          options:
                            in:
                              - month
                              - year
          headers: {}
          x-apidog-name: Success
        '422':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: object
                    properties:
                      period:
                        type: array
                        items:
                          type: object
                          properties:
                            error:
                              type: string
                            message:
                              type: string
                            options:
                              type: object
                              properties: {}
                              x-apidog-orders: []
                              x-apidog-ignore-properties: []
                          x-apidog-orders:
                            - error
                            - message
                            - options
                          x-apidog-ignore-properties: []
                      offset:
                        type: array
                        items:
                          type: object
                          properties:
                            error:
                              type: string
                            message:
                              type: string
                            options:
                              type: object
                              properties: {}
                              x-apidog-orders: []
                              x-apidog-ignore-properties: []
                          x-apidog-orders:
                            - error
                            - message
                            - options
                          x-apidog-ignore-properties: []
                    x-apidog-orders:
                      - period
                      - offset
                    x-apidog-ignore-properties: []
                required:
                  - error
                  - details
                x-apidog-orders:
                  - error
                  - details
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Parameter Error
      security: []
      x-apidog-folder: API Reference/Management API/Core/Billing/Data transfer
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-4329075-run
components:
  schemas:
    DataTransferBilling:
      type: object
      properties:
        request_bytes:
          type: integer
          minimum: 0
        response_bytes:
          type: integer
          minimum: 0
      required:
        - request_bytes
        - response_bytes
      x-apidog-orders:
        - request_bytes
        - response_bytes
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```