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

# Usage report

> Agency (white-label) keys get usage broken down per client brand — images, videos, and credits — for invoicing. Personal keys get their own totals. Defaults to the current calendar month.




## OpenAPI

````yaml /openapi.yaml get /v1/usage
openapi: 3.1.0
info:
  title: Cherry Shot API
  version: 1.0.0
  description: >
    Generate studio-quality product photography and video ads programmatically.
    Authenticate with an API key (`Authorization: Bearer cs_...` or `x-api-key:
    cs_...`). Generation is asynchronous: create a shoot or video, then poll it
    until `status` is `completed`. Credits are charged the same as in the app.
servers:
  - url: https://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
paths:
  /v1/usage:
    get:
      summary: Usage report
      description: >
        Agency (white-label) keys get usage broken down per client brand —
        images, videos, and credits — for invoicing. Personal keys get their own
        totals. Defaults to the current calendar month.
      parameters:
        - in: query
          name: from
          schema:
            type: string
            format: date-time
          description: Period start (ISO 8601). Defaults to the start of the current month.
        - in: query
          name: to
          schema:
            type: string
            format: date-time
          description: Period end (ISO 8601). Defaults to now.
        - in: query
          name: brand
          schema:
            type: string
          description: Filter to one client brand id (agency keys only).
      responses:
        '200':
          description: Usage report
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    example: usage_report
                  period:
                    type: object
                    properties:
                      from:
                        type: string
                      to:
                        type: string
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        brand_id:
                          type: string
                          nullable: true
                        brand_name:
                          type: string
                          nullable: true
                        images:
                          type: integer
                        image_credits:
                          type: integer
                        videos:
                          type: integer
                        video_credits:
                          type: integer
                  totals:
                    type: object
                    properties:
                      images:
                        type: integer
                      videos:
                        type: integer
                      credits:
                        type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
    BearerAuth:
      type: http
      scheme: bearer

````