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

# Get deliverable detail report data

> Retrieves paginated deliverable report data with comprehensive filtering, sorting, and subscription-based access control. Shows deals, athletes, deliverables, and performance metrics. Engagement metrics (CPM, CPE, impressions) require premium subscription.



## OpenAPI

````yaml /storage/api-docs/api-docs.json post /partner/deliverableReport
openapi: 3.0.0
info:
  title: MOGL Core API
  description: >-
    MOGL Platform Core API — powering athlete NIL deals, brand partnerships,
    agent management, payments, messaging, and more.
     *
     * ## Authentication
     * - **JWT Bearer Token**: Most endpoints require a Bearer token obtained via `/api/login`.
     * - **Server-to-Server API Key**: Internal/lambda/cron endpoints use an `X-API-KEY` header.
     *
     * ## Rate Limiting
     * - Registration & login endpoints: 4–15 requests per minute
     * - Public/influencer endpoints: 200 requests per minute
     * - Authenticated endpoints: standard Laravel throttle
  version: 1.0.0
servers:
  - url: http://localhost/mogl/mogl-backend/api
    description: Local
  - url: https://dev-api.mogl.online/api
    description: Dev
  - url: https://staging-api.mogl.online/api
    description: Staging
  - url: https://api.mogl.online/api
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Login, registration, password reset
  - name: User Registration - Common
    description: Common user registration & email check
  - name: User Registration - Athlete
    description: Athlete registration & onboarding steps
  - name: User Registration - Partner
    description: Partner/Brand registration & onboarding steps
  - name: User Registration - Agent
    description: Agent registration & onboarding steps
  - name: User Registration - Fan
    description: Fan registration & onboarding steps
  - name: User Profile
    description: User profile management, settings, social media
  - name: Athlete
    description: 'Athlete-specific endpoints: search, details, availability'
  - name: Athlete - Availability Confirmation
    description: Post-hiring availability confirmation workflow
  - name: Athlete - NIL Feed
    description: Athlete NIL feed and partner search
  - name: Athlete - AI Assistant
    description: AI-powered job assistant for athletes — chat and conversation history
  - name: Partner
    description: Partner/Brand-specific endpoints
  - name: Partner - External Job
    description: External job link & applicant management
  - name: Partner - Deliverable Report
    description: Deliverable detail reports for brands
  - name: Partner - Screening Questions
    description: Screening question reports
  - name: Partner - Contract Management
    description: Brand contract management with athletes
  - name: Partner - Content Library
    description: Brand content library for deliverable assets
  - name: Agent
    description: Agent profile, athlete management, contracts
  - name: Agent - Athletes
    description: Agent-athlete relationship management
  - name: Agent - Stripe
    description: Agent payment methods & billing via Stripe
  - name: Agent - Contracts
    description: Agent athlete contract management
  - name: Agent - Availability Confirmation
    description: Agent managing athlete job availability
  - name: Jobs
    description: Job/deal CRUD, search, invitations, hiring, deliverables
  - name: Deals
    description: Deal listing, my deals, bulk operations
  - name: Deal Folder
    description: >-
      Deal folder file workflow — uploads, replacements, approvals, revisions,
      comments. Accessible by athlete, partner/brand, agent, and iOS clients
      (per-action authorisation enforced server-side).
  - name: Deal Folder iOS API
    description: >-
      iOS-only direct-to-S3 multipart upload endpoints for deal folder files
      (initiate/complete for new uploads and replacements). Web clients should
      use the standard `Deal Folder` upload/replace endpoints instead.
  - name: Chat
    description: Messaging, chat contacts, notifications
  - name: Notifications
    description: Notification preferences, in-app notifications
  - name: Payments
    description: Stripe payments, payment history, cards, bulk pay
  - name: Subscription
    description: Brand subscription plans & management
  - name: Public Pages
    description: Public content endpoints (no auth required)
  - name: Public - Influencer/SEO
    description: Public influencer discovery, sitemaps, directories
  - name: Services
    description: Athlete service marketplace
  - name: iOS Device
    description: iOS device tokens, live activities
  - name: Onboarding Tutorial
    description: Onboarding tutorial progress
  - name: MOGL Rosters
    description: Roster management & display
  - name: Internal / Cron
    description: Server-to-server and cron job endpoints
  - name: Affiliate
    description: Athlete affiliate links & tracking
paths:
  /partner/deliverableReport:
    post:
      tags:
        - Partner - Deliverable Report
      summary: Get deliverable detail report data
      description: >-
        Retrieves paginated deliverable report data with comprehensive
        filtering, sorting, and subscription-based access control. Shows deals,
        athletes, deliverables, and performance metrics. Engagement metrics
        (CPM, CPE, impressions) require premium subscription.
      operationId: deliverableReport
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                date_filter_range:
                  description: >-
                    Date range filter. Predefined: last_month, last_week,
                    this_week, All. Or custom range as 'YYYY/MM/DD-YYYY/MM/DD'
                  type: string
                  example: last_month
                job_id:
                  description: Filter by specific job/deal ID
                  type: integer
                  example: 100
                  nullable: true
                athlete_id:
                  description: Filter by specific athlete ID
                  type: integer
                  example: 200
                  nullable: true
                deliverable_id:
                  description: Filter by milestone template ID (milestones.id)
                  type: integer
                  example: 300
                  nullable: true
                sort_column:
                  description: Column key to sort by
                  type: string
                  enum:
                    - deal_id
                    - deal_name
                    - category
                    - athlete_name
                    - hire_date
                    - deal_completion_date
                    - deliverable_id
                    - deliverable_number
                    - deliverable_type
                    - due_date
                    - submitted
                    - submitted_date
                    - approved
                    - approval_date
                    - preview
                    - proof_of_work
                    - cost
                    - cpm
                    - impressions
                    - cpe
                    - total_engagements
                    - engagement_rate
                    - comments
                    - likes
                    - shares
                    - bookmarks
                    - retweets
                    - last_date_refresh
                  example: deal_id
                  nullable: true
                sort_order:
                  description: Sort direction
                  type: string
                  enum:
                    - asc
                    - desc
                    - ASC
                    - DESC
                  example: DESC
                  nullable: true
                timezone_diff:
                  description: >-
                    Timezone offset in decimal hours from UTC (e.g. -5.5 for
                    EST)
                  type: number
                  format: float
                  example: -5
                  nullable: true
                page:
                  description: Page number
                  type: integer
                  example: 1
                  nullable: true
                limit:
                  description: Items per page (default 10)
                  type: integer
                  example: 10
                  nullable: true
                page_limit:
                  description: Alias for limit (takes priority over limit if both sent)
                  type: integer
                  example: 25
                  nullable: true
                filter:
                  description: >-
                    Column-level filters object. Keys are column names, values
                    are filter objects.
                  properties:
                    deal_id:
                      properties:
                        type:
                          type: string
                          enum:
                            - equals
                            - notEqual
                            - lessThan
                            - greaterThan
                            - inRange
                            - contains
                            - notContains
                            - startsWith
                            - endsWith
                            - blank
                            - notBlank
                          example: equals
                        filter:
                          description: Filter value
                          type: string
                          example: '100'
                        filterTo:
                          description: End value for range filters
                          type: string
                          example: '200'
                        filterType:
                          type: string
                          enum:
                            - number
                            - date
                          example: number
                      type: object
                      example: []
                    athlete_name:
                      description: 'Dropdown filter: array of {id, name}'
                      type: array
                      items:
                        properties:
                          id:
                            type: integer
                            example: 200
                          name:
                            type: string
                            example: John Doe
                        type: object
                      example: []
                    category:
                      description: 'Dropdown filter: array of {id, name}'
                      type: array
                      items:
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type: string
                            example: Social Media
                        type: object
                      example: []
                    submitted:
                      description: 'Dropdown filter: Y or N'
                      type: array
                      items:
                        properties:
                          id:
                            type: string
                            enum:
                              - 'Y'
                              - 'N'
                            example: 'Y'
                        type: object
                      example: []
                    approved:
                      description: 'Dropdown filter: Y or N'
                      type: array
                      items:
                        properties:
                          id:
                            type: string
                            enum:
                              - 'Y'
                              - 'N'
                            example: 'Y'
                        type: object
                      example: []
                  type: object
                  example: []
              type: object
      responses:
        '200':
          description: Deliverable report data
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: data found
                  data:
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      data:
                        type: array
                        items:
                          properties:
                            deal_id:
                              type: integer
                              example: 1
                            deal_name:
                              type: string
                              example: Summer Campaign
                            athlete_name:
                              type: string
                              example: John Doe
                            category:
                              type: string
                              example: Social Media
                            hire_date:
                              type: string
                              format: date-time
                              example: '2026-01-15T12:00:00Z'
                            deliverable_type:
                              type: string
                              example: Instagram post
                            submitted:
                              type: string
                              enum:
                                - 'Y'
                                - 'N'
                              example: 'Y'
                            approved:
                              type: string
                              enum:
                                - 'Y'
                                - 'N'
                              example: 'Y'
                            cost:
                              type: number
                              example: 500
                            cpm:
                              type: number
                              example: 12.5
                            cpe:
                              type: number
                              example: 0.45
                            impressions:
                              type: integer
                              example: 10000
                            engagement_rate:
                              type: number
                              example: 3.25
                            preview:
                              type: string
                              example: https://example.com/preview.jpg
                            proof_of_work:
                              type: string
                              example: https://example.com/proof.pdf
                          type: object
                        example: []
                      total:
                        type: integer
                        example: 100
                      per_page:
                        type: integer
                        example: 10
                      last_page:
                        type: integer
                        example: 10
                    type: object
                    example: []
                type: object
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        JWT Bearer token authentication. Use the /api/login endpoint to obtain a
        token.
      scheme: bearer
      bearerFormat: JWT

````