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

> Query your team AI credit consumption over time. Filter by group, project, or API key with day, week, month, or year granularity.

# Get team credit usage over time



## OpenAPI

````yaml post /v1/analytics/team-credit-usage
openapi: 3.0.0
info:
  description: >-
    The Magnific API is your gateway to a vast collection of high-quality
    digital resources for your applications and projects. As a leading platform,
    it offers a wide range of graphics, including vectors, photos,
    illustrations, icons, PSD templates, and more, all curated by talented
    designers from around the world.
  title: Magnific API
  version: 1.0.0
servers:
  - description: B2B API Production V1
    url: https://api.magnific.com
security:
  - magnificApiKey: []
paths:
  /v1/analytics/team-credit-usage:
    post:
      tags:
        - Analytics
      summary: Get team credit usage over time
      description: >
        Returns credit consumption for the caller's team aggregated into time
        buckets.

        Authenticates via API key (`X-Magnific-API-Key` header). The caller's
        identity

        is resolved automatically from the API key.


        Response always includes per-user breakdown with email and per-project
        grouping

        (same data as the CSV export). Tool names are returned as display names

        (e.g. "AI Image Models", "Asset Download") instead of internal codes.


        Date range limits: Enterprise up to 365 days, Business up to 180 days.

        If no dates are provided, defaults to the last 7 days.


        Available exclusively for Business and Enterprise plans. Rate limit: 100
        RPD.


        Response field mapping (differs from internal endpoints):

        - `tool`: display name (e.g. "AI Image Models") instead of internal code

        - `user_uses`: number of operations (replaces `count`)

        - `user_credits`: credits consumed (replaces `total_amount`/`amount`)

        - `project_reference`: project UUID (replaces `folder_reference`)
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/_v1_analytics_team_credit_usage_post_request
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                example-team-credit-usage:
                  $ref: '#/components/examples/200-analytics-team-credit-usage'
              schema:
                $ref: >-
                  #/components/schemas/_v1_analytics_team_credit_usage_post_200_response
          description: OK
        '400':
          content:
            application/json:
              examples:
                invalid_page:
                  summary: Parameter 'page' is not valid
                  value:
                    message: Parameter 'page' must be greater than 0
                invalid_query:
                  summary: Parameter 'query' is not valid
                  value:
                    message: Parameter 'query' must not be empty
                invalid_filter:
                  summary: Parameter 'filter' is not valid
                  value:
                    message: Parameter 'filter' is not valid
                generic_bad_request:
                  summary: Bad Request
                  value:
                    message: Parameter ':attribute' is not valid
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_400_response'
            application/problem+json:
              examples:
                invalid_page:
                  summary: Parameter 'page' is not valid
                  value:
                    message: Validation error
                    invalid_params:
                      - field: page
                        reason: Parameter 'page' must be greater than 0
                      - field: per_page
                        reason: Parameter 'per_page' must be greater than 0
              schema:
                $ref: >-
                  #/components/schemas/get_all_style_transfer_tasks_400_response_1
          description: >-
            Bad Request - The server could not understand the request due to
            invalid syntax.
        '403':
          content:
            application/json:
              examples:
                user_not_authorized:
                  summary: User has not privileges to access some resource
                  value:
                    message: User is not authorized to access this resource
                user_not_owner:
                  summary: Collection author id is different from current user's id
                  value:
                    message: User is not owner of requested collection
                item_is_premium:
                  summary: The user cannot download this item because it is premium
                  value:
                    message: The user cannot download this item because it is premium
                creator_not_authorized:
                  summary: Creator has not privileges to access some resource
                  value:
                    message: Creator is not authorized to access this resource
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_400_response'
          description: >-
            Forbidden - The client does not have permission to access the
            requested resource.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_500_response'
          description: >-
            Internal Server Error - The server has encountered a situation it
            doesn't know how to handle.
components:
  schemas:
    _v1_analytics_team_credit_usage_post_request:
      properties:
        granularity:
          default: day
          description: >-
            Time bucket granularity for aggregation. Defaults to `day` if
            omitted.
          enum:
            - day
            - week
            - month
            - year
          example: month
          type: string
        start_date:
          description: Start date for the query range (YYYY-MM-DD). Defaults to 7 days ago.
          example: '2026-01-01T00:00:00.000Z'
          format: date
          type: string
        end_date:
          description: End date for the query range (YYYY-MM-DD). Defaults to today.
          example: '2026-03-31T00:00:00.000Z'
          format: date
          type: string
        project_references:
          description: Filter by specific project references.
          example:
            - a1b2c3d4-1111-4000-8000-000000000001
          items:
            format: uuid
            type: string
          type: array
        api_key_ids:
          description: Filter by specific API key IDs.
          example:
            - api-key-1
            - api-key-2
          items:
            type: string
          type: array
        group_ids:
          description: >-
            Filter by specific team group IDs. Members of these groups are
            included in the results.
          example:
            - 10
            - 20
          items:
            minimum: 1
            type: integer
          type: array
      type: object
    _v1_analytics_team_credit_usage_post_200_response:
      example:
        data:
          - date: '2026-01-01T00:00:00.000Z'
            consumptions:
              - tool: AI Image Models
                user_uses: 45
                user_credits: 1800
                user_usages:
                  - user_email: designer@company.com
                    user_uses: 30
                    user_credits: 1200
                    project_reference: a1b2c3d4-1111-4000-8000-000000000001
                    project_name: Marketing Campaign
                    group_name: Design Team
                  - user_email: designer@company.com
                    user_uses: 30
                    user_credits: 1200
                    project_reference: a1b2c3d4-1111-4000-8000-000000000001
                    project_name: Marketing Campaign
                    group_name: Design Team
              - tool: AI Image Models
                user_uses: 45
                user_credits: 1800
                user_usages:
                  - user_email: designer@company.com
                    user_uses: 30
                    user_credits: 1200
                    project_reference: a1b2c3d4-1111-4000-8000-000000000001
                    project_name: Marketing Campaign
                    group_name: Design Team
                  - user_email: designer@company.com
                    user_uses: 30
                    user_credits: 1200
                    project_reference: a1b2c3d4-1111-4000-8000-000000000001
                    project_name: Marketing Campaign
                    group_name: Design Team
          - date: '2026-01-01T00:00:00.000Z'
            consumptions:
              - tool: AI Image Models
                user_uses: 45
                user_credits: 1800
                user_usages:
                  - user_email: designer@company.com
                    user_uses: 30
                    user_credits: 1200
                    project_reference: a1b2c3d4-1111-4000-8000-000000000001
                    project_name: Marketing Campaign
                    group_name: Design Team
                  - user_email: designer@company.com
                    user_uses: 30
                    user_credits: 1200
                    project_reference: a1b2c3d4-1111-4000-8000-000000000001
                    project_name: Marketing Campaign
                    group_name: Design Team
              - tool: AI Image Models
                user_uses: 45
                user_credits: 1800
                user_usages:
                  - user_email: designer@company.com
                    user_uses: 30
                    user_credits: 1200
                    project_reference: a1b2c3d4-1111-4000-8000-000000000001
                    project_name: Marketing Campaign
                    group_name: Design Team
                  - user_email: designer@company.com
                    user_uses: 30
                    user_credits: 1200
                    project_reference: a1b2c3d4-1111-4000-8000-000000000001
                    project_name: Marketing Campaign
                    group_name: Design Team
      properties:
        data:
          items:
            $ref: '#/components/schemas/team_credit_usage_response_inner'
          type: array
      type: object
    get_all_style_transfer_tasks_400_response:
      example:
        message: message
      properties:
        message:
          type: string
      type: object
    get_all_style_transfer_tasks_400_response_1:
      properties:
        problem:
          $ref: >-
            #/components/schemas/get_all_style_transfer_tasks_400_response_1_problem
      type: object
    get_all_style_transfer_tasks_500_response:
      example:
        message: Internal Server Error
      properties:
        message:
          example: Internal Server Error
          type: string
      type: object
    team_credit_usage_response_inner:
      example:
        date: '2026-01-01T00:00:00.000Z'
        consumptions:
          - tool: AI Image Models
            user_uses: 45
            user_credits: 1800
            user_usages:
              - user_email: designer@company.com
                user_uses: 30
                user_credits: 1200
                project_reference: a1b2c3d4-1111-4000-8000-000000000001
                project_name: Marketing Campaign
                group_name: Design Team
              - user_email: designer@company.com
                user_uses: 30
                user_credits: 1200
                project_reference: a1b2c3d4-1111-4000-8000-000000000001
                project_name: Marketing Campaign
                group_name: Design Team
          - tool: AI Image Models
            user_uses: 45
            user_credits: 1800
            user_usages:
              - user_email: designer@company.com
                user_uses: 30
                user_credits: 1200
                project_reference: a1b2c3d4-1111-4000-8000-000000000001
                project_name: Marketing Campaign
                group_name: Design Team
              - user_email: designer@company.com
                user_uses: 30
                user_credits: 1200
                project_reference: a1b2c3d4-1111-4000-8000-000000000001
                project_name: Marketing Campaign
                group_name: Design Team
      properties:
        date:
          description: Start date of the time period.
          example: '2026-01-01T00:00:00.000Z'
          format: date-time
          type: string
        consumptions:
          items:
            $ref: >-
              #/components/schemas/team_credit_usage_response_inner_consumptions_inner
          type: array
      type: object
    get_all_style_transfer_tasks_400_response_1_problem:
      properties:
        message:
          example: Validation error
          type: string
        invalid_params:
          items:
            $ref: >-
              #/components/schemas/get_all_style_transfer_tasks_400_response_1_problem_invalid_params_inner
          type: array
      required:
        - invalid_params
        - message
      type: object
    team_credit_usage_response_inner_consumptions_inner:
      example:
        tool: AI Image Models
        user_uses: 45
        user_credits: 1800
        user_usages:
          - user_email: designer@company.com
            user_uses: 30
            user_credits: 1200
            project_reference: a1b2c3d4-1111-4000-8000-000000000001
            project_name: Marketing Campaign
            group_name: Design Team
          - user_email: designer@company.com
            user_uses: 30
            user_credits: 1200
            project_reference: a1b2c3d4-1111-4000-8000-000000000001
            project_name: Marketing Campaign
            group_name: Design Team
      properties:
        tool:
          description: Tool display name.
          example: AI Image Models
          type: string
        user_uses:
          description: Number of operations in this period.
          example: 45
          type: integer
        user_credits:
          description: Total credits consumed.
          example: 1800
          type: integer
        user_usages:
          description: Per-user breakdown with email. Always included.
          items:
            $ref: >-
              #/components/schemas/team_credit_usage_response_inner_consumptions_inner_user_usages_inner
          type: array
      type: object
    get_all_style_transfer_tasks_400_response_1_problem_invalid_params_inner:
      properties:
        name:
          description: Name of the invalid parameter.
          example: page
          type: string
        field:
          description: Field of the invalid parameter. Mirrors `name`.
          example: page
          type: string
        reason:
          example: Parameter 'page' must be greater than 0
          type: string
      required:
        - field
        - name
        - reason
      type: object
    team_credit_usage_response_inner_consumptions_inner_user_usages_inner:
      example:
        user_email: designer@company.com
        user_uses: 30
        user_credits: 1200
        project_reference: a1b2c3d4-1111-4000-8000-000000000001
        project_name: Marketing Campaign
        group_name: Design Team
      properties:
        user_email:
          description: User email address.
          example: designer@company.com
          type: string
        user_uses:
          description: Number of operations by this user.
          example: 30
          type: integer
        user_credits:
          description: Credits consumed by this user.
          example: 1200
          type: integer
        project_reference:
          description: Project UUID, if any.
          example: a1b2c3d4-1111-4000-8000-000000000001
          type: string
        project_name:
          description: Project name, if resolvable.
          example: Marketing Campaign
          type: string
        group_name:
          description: Group name, if resolvable.
          example: Design Team
          type: string
      type: object
  examples:
    200-analytics-team-credit-usage:
      summary: Success - Team credit usage with per-user breakdown.
      value:
        data:
          - date: '2026-01-01T00:00:00.000Z'
            consumptions:
              - tool: AI Image Models
                user_uses: 45
                user_credits: 1800
                user_usages:
                  - user_email: designer@company.com
                    user_uses: 30
                    user_credits: 1200
                    project_reference: a1b2c3d4-1111-4000-8000-000000000001
                    project_name: Marketing Campaign
                    group_name: Design Team
                  - user_email: developer@company.com
                    user_uses: 15
                    user_credits: 600
              - tool: Asset Download
                user_uses: 10
                user_credits: 900
  securitySchemes:
    magnificApiKey:
      description: >
        Your Magnific API key. Required for authentication. [Learn how to obtain
        an API key](https://docs.magnific.com/quickstart)
      in: header
      name: x-magnific-api-key
      type: apiKey

````