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

# Get organization's year in review

> Retrieves wrapped statistics for a given year. For large datasets (>10,000 donations)



## OpenAPI

````yaml get /admin/wrapped/{year}
openapi: 3.0.0
info:
  title: Example for response examples value
  version: '1.0'
servers:
  - url: https://api.helpyousponsor.com/v1
    description: Production
security: []
paths:
  /admin/wrapped/{year}:
    get:
      tags:
        - Wrapped
      summary: Get organization's year in review
      description: >-
        Retrieves wrapped statistics for a given year. For large datasets
        (>10,000 donations)
      operationId: 48f627d42fc8be978931beb9f57cea23
      parameters:
        - name: year
          in: path
          description: >-
            Year to get wrapped data for. Must not be a future year. If not
            specified, defaults to current year.
          required: false
          schema:
            description: Any past year or current year
            type: integer
            example: 2024
        - name: refresh
          in: query
          description: >-
            Force refresh of wrapped statistics. For large datasets (>10,000
            donations), triggers async calculation.
          required: false
          schema:
            type: boolean
            example: false
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                properties:
                  metrics:
                    properties:
                      overview:
                        properties:
                          totalDonations:
                            type: integer
                            example: 1234
                          totalAmount:
                            type: number
                            example: 567890
                          newDonors:
                            type: integer
                            example: 89
                          avgDonation:
                            type: number
                            example: 460
                        type: object
                      monthly:
                        type: array
                        items:
                          properties:
                            month:
                              type: string
                              example: 2024-01
                            donationCount:
                              type: integer
                              example: 123
                            amount:
                              type: number
                              example: 45000
                          type: object
                      donorGrowth:
                        properties:
                          newDonors:
                            type: integer
                            example: 89
                          totalDonors:
                            type: integer
                            example: 500
                          growthRate:
                            type: number
                            example: 17.8
                        type: object
                      programPerformance:
                        type: array
                        items:
                          properties:
                            programId:
                              type: integer
                              example: 1
                            programName:
                              type: string
                              example: Education Fund
                            totalDonations:
                              type: integer
                              example: 150
                            totalAmount:
                              type: number
                              example: 75000
                            commitments:
                              properties:
                                total:
                                  type: integer
                                  example: 50
                                active:
                                  type: integer
                                  example: 45
                                pastDue:
                                  type: integer
                                  example: 3
                                inactive:
                                  type: integer
                                  example: 2
                                uniqueDonors:
                                  type: integer
                                  example: 40
                                donorsWithoutCommitments:
                                  type: integer
                                  example: 10
                                totalAmount:
                                  type: number
                                  example: 25000
                                annualizedAmount:
                                  type: number
                                  example: 300000
                              type: object
                          type: object
                      retention:
                        properties:
                          retentionRate:
                            type: number
                            example: 75.5
                          retainedDonors:
                            type: integer
                            example: 300
                          previousYearDonors:
                            type: integer
                            example: 400
                          currentYearDonors:
                            type: integer
                            example: 450
                        type: object
                      topDonors:
                        type: array
                        items:
                          properties:
                            donorId:
                              type: integer
                              example: 123
                            donationCount:
                              type: integer
                              example: 5
                            totalAmount:
                              type: number
                              example: 25000
                            name:
                              type: string
                              example: Anonymous
                          type: object
                      avgFillTime:
                        type: number
                        example: 14.5
                    type: object
                  descriptions:
                    properties:
                      overview:
                        properties:
                          title:
                            type: string
                            example: Your Year in Giving
                          description:
                            type: string
                          stats:
                            type: object
                        type: object
                      donorGrowth:
                        properties:
                          title:
                            type: string
                            example: Growing Together
                          description:
                            type: string
                          stats:
                            type: object
                        type: object
                      retention:
                        properties:
                          title:
                            type: string
                            example: Lasting Connections
                          description:
                            type: string
                          stats:
                            type: object
                        type: object
                      monthly:
                        properties:
                          title:
                            type: string
                            example: Monthly Impact
                          description:
                            type: string
                          stats:
                            type: object
                        type: object
                      programPerformance:
                        properties:
                          title:
                            type: string
                            example: Program Success
                          description:
                            type: string
                          stats:
                            type: object
                        type: object
                      summary:
                        properties:
                          title:
                            type: string
                            example: 2024 Impact Story
                          description:
                            type: string
                          stats:
                            type: object
                        type: object
                    type: object
                  lastUpdated:
                    type: string
                    format: date-time
                type: object
        '202':
          description: Stats are being calculated
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    example: reloading
                  message:
                    type: string
                    example: >-
                      Statistics are being recalculated. Please try again in a
                      few minutes.
                type: object
        '400':
          description: Invalid year parameter
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: Cannot generate wrapped for future years
                type: object
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: Unauthenticated
                type: object
        '403':
          description: Unauthorized
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: Unauthorized
                type: object
        '500':
          description: Server error
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: Error fetching wrapped data
                  error:
                    type: string
                    example: Internal server error message
                type: object
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      description: 'API key generated from Developer Settings. Format: hys_...'
      name: X-HYS-API-Key
      in: header

````