> ## Documentation Index
> Fetch the complete documentation index at: https://docs.goshippo.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Shippo is a multi-carrier shipping API. For agent integrations that execute shipping operations (rates, labels, tracking, address validation, customs), connect the hosted Shippo MCP server at https://mcp.shippo.com (per-user OAuth; setup at /guides/mcp-server). To search and read this documentation from an agent, a docs search MCP is available at https://docs.goshippo.com/mcp. Shipping workflow knowledge (agent skills and a knowledge pack) is published at https://github.com/goshippo/ai. For REST integrations start at /guides/api-quickstart; test mode uses shippo_test_ API keys.

# Get Report Type



## OpenAPI

````yaml /api-reference/reporting-api/openapi.yaml get /v2/reporting/reports/{report_type}
openapi: 3.1.0
info:
  title: Reporting API
  version: 0.1.0
servers:
  - url: https://api.goshippo.com
security: []
paths:
  /v2/reporting/reports/{report_type}:
    get:
      tags:
        - Reports
      summary: Get Report Type
      operationId: get_report_type
      parameters:
        - name: report_type
          in: path
          required: true
          schema:
            type: string
            title: Report Type
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportTypeResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                required:
                  - detail
              example:
                detail: Authentication credentials were not provided.
        '404':
          description: Report type not found
          content:
            application/problem+json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: integer
                  detail:
                    type: string
              example:
                type: https://reporthub.shippo.com/errors/report-type-not-found
                title: Report Type Not Found
                status: 404
                detail: The requested report type was not found.
        '422':
          description: Validation error
          content:
            application/problem+json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: integer
                  detail:
                    type: string
              example:
                type: https://reporthub.shippo.com/errors/validation-error
                title: Validation Error
                status: 422
                detail: The request is invalid.
      security:
        - ShippoTokenAuth: []
components:
  schemas:
    ReportTypeResponse:
      properties:
        report_type:
          type: string
          title: Report Type
        name:
          type: string
          title: Name
        category:
          type: string
          title: Category
        description:
          type: string
          title: Description
        available_columns:
          items:
            $ref: '#/components/schemas/PublicReportColumnResponse'
          type: array
          title: Available Columns
        data_availability:
          oneOf:
            - $ref: '#/components/schemas/PendingDataAvailabilityResponse'
            - $ref: '#/components/schemas/ReadyDataAvailabilityResponse'
          title: Data Availability
          discriminator:
            propertyName: status
            mapping:
              pending:
                $ref: '#/components/schemas/PendingDataAvailabilityResponse'
              ready:
                $ref: '#/components/schemas/ReadyDataAvailabilityResponse'
      type: object
      required:
        - report_type
        - name
        - category
        - description
        - available_columns
        - data_availability
      title: ReportTypeResponse
      description: >-
        Report type metadata returned by the Reporting API.


        The version is embedded in the ``report_type`` key (for example

        ``invoice.v1``) and discovery only returns active types, so neither fact
        is

        repeated as a separate field.
    PublicReportColumnResponse:
      properties:
        name:
          type: string
          title: Name
        display_name:
          type: string
          title: Display Name
        is_default:
          type: boolean
          title: Is Default
      type: object
      required:
        - name
        - display_name
        - is_default
      title: PublicReportColumnResponse
      description: Column metadata returned by report type discovery.
    PendingDataAvailabilityResponse:
      properties:
        status:
          type: string
          const: pending
          title: Status
      type: object
      required:
        - status
      title: PendingDataAvailabilityResponse
      description: Data availability state while bounds are still being computed.
    ReadyDataAvailabilityResponse:
      properties:
        status:
          type: string
          const: ready
          title: Status
        start:
          type: integer
          title: Start
          example: 1704067200
        end:
          type: integer
          title: End
          example: 1706745600
        updated:
          type: integer
          title: Updated
      type: object
      required:
        - status
        - start
        - end
        - updated
      title: ReadyDataAvailabilityResponse
      description: Available data bounds and the time they were last checked.
  securitySchemes:
    ShippoTokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Shippo API token header, for example `ShippoToken shippo_live_xxxx`.

````

## Related topics

- [Get Report Run](/api-reference/report-runs/get-report-run.md)
- [List Report Types](/api-reference/reports/list-report-types.md)
- [Discover available reports](/reporting-api/discover-reports.md)