# Show data transfer breakdown ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/billing/data_transfer/breakdown: get: summary: Show data transfer breakdown deprecated: false description: | ### Groups per grouping type tags: - API Reference/Management API/Core/Billing/Data transfer parameters: - name: period in: query description: >+ Length of period for breakdown. If provided requires offset param. If not provided will return all time yearly breakdown. 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: type in: query description: Type of data required: false example: files schema: type: string enum: - files - emails - webforms - websites x-apidog-enum: - name: '' value: files description: '' - name: '' value: emails description: '' - name: '' value: webforms description: '' - value: websites name: '' description: '' - name: grouping in: query description: Group types that the period will be divided into required: false example: type schema: type: string enum: - type x-apidog-enum: - name: '' value: type description: '' - 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: total: type: array items: &ref_0 $ref: '#/components/schemas/DataTransferBillingGroup' breakdown: type: array items: type: object properties: period: type: string data: type: array items: *ref_0 x-apidog-orders: - period - data x-apidog-ignore-properties: [] required: - total - breakdown x-apidog-orders: - total - breakdown x-apidog-ignore-properties: [] examples: '1': summary: Success - grouping by purpose value: total: - group: files request_bytes: 33377600 cost: 84323564 breakdown: - period: '01.2025' data: - group: files request_bytes: 50010740 cost: 35494327 '2': summary: Exception value: error: Invalid parameters details: period: - error: inclusion message: is not included in the list options: in: - month - year '3': summary: Success - grouping by channel value: total: - group: total count: 3 cost: '15.0' - group: sms count: 1 cost: '5.0' parts: 5 - group: email count: 1 cost: '5.0' - group: push count: 1 cost: '5.0' breakdown: - period: 01.05.2024 data: - group: total count: 3 cost: '15.0' - group: sms count: 1 cost: '5.0' parts: 5 - group: email count: 1 cost: '5.0' - group: push count: 1 cost: '5.0' 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: [] type: 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: [] grouping: 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 - type - grouping 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-4329076-run components: schemas: DataTransferBillingGroup: type: object properties: group: type: string request_bytes: type: integer minimum: 0 response_bytes: type: integer minimum: 0 required: - group - request_bytes - response_bytes x-apidog-orders: - group - request_bytes - response_bytes x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: {} servers: - url: https://api.mpc.dev.placewise.com description: Staging security: [] ```