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

# Get project status and usage

> Returns whether the project is paused and its usage: active prompts, credits spent this credit period, AI Traffic events this UTC month and tracked pages. Each figure carries its own period. Every API key holds project.read without selecting it.



## OpenAPI

````yaml /openapi.json get /projects/{projectId}/usage
openapi: 3.1.0
info:
  title: DevTune API
  version: 2.0.0
  description: >-
    API for programmatic access to your AI visibility data, webhook
    subscriptions, and automation workflows. Use this API to integrate DevTune
    data into CI/CD pipelines, BI tools, AI agents, and operational systems.
servers:
  - url: https://devtune.ai/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /projects/{projectId}/usage:
    get:
      summary: Get project status and usage
      description: >-
        Returns whether the project is paused and its usage: active prompts,
        credits spent this credit period, AI Traffic events this UTC month and
        tracked pages. Each figure carries its own period. Every API key holds
        project.read without selecting it.
      operationId: getProjectUsage
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Project status and usage
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ProjectUsageData'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '429':
          $ref: '#/components/responses/RateLimitExceededError'
components:
  schemas:
    ProjectUsageData:
      type: object
      required:
        - projectId
        - paused
        - prompts
        - credits
        - aiTrafficEvents
        - trackedPages
      properties:
        projectId:
          type: string
          format: uuid
        paused:
          type: boolean
          description: >-
            A paused project starts no probes, agents, crawls, audits or data
            syncs and drops new AI Traffic. Credentials keep read access only
            until it is resumed in the app. Its prompts and project slot do not
            count against the account while paused.
        prompts:
          type: object
          required:
            - active
          properties:
            active:
              type: integer
              minimum: 0
        credits:
          type: object
          required:
            - used
            - periodStart
            - periodEnd
          description: >-
            Credits spent in the account credit period, including credits held
            by running work until it settles.
          properties:
            used:
              type: number
              minimum: 0
            periodStart:
              type: string
              format: date
            periodEnd:
              type: string
              format: date
              description: Exclusive end of the period.
        aiTrafficEvents:
          type: object
          required:
            - count
            - periodStart
            - periodEnd
          description: >-
            AI Traffic events this UTC calendar month from the project rollups.
            Across projects this can differ slightly from the account meter,
            which counts at ingest.
          properties:
            count:
              type: integer
              minimum: 0
            periodStart:
              type: string
              format: date
            periodEnd:
              type: string
              format: date
              description: Exclusive end of the period.
        trackedPages:
          type:
            - object
            - 'null'
          required:
            - used
            - limit
          description: >-
            Tracked and reserved pages against the page limit. Null until the
            first page-tracking status is computed.
          properties:
            used:
              type: integer
              minimum: 0
            limit:
              type: integer
              minimum: 0
    Meta:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
        projectId:
          type: string
          format: uuid
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        status:
          type: integer
      required:
        - error
        - message
        - status
  responses:
    UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ForbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimitExceededError:
      description: Rate limit exceeded
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  headers:
    X-RateLimit-Limit:
      description: Maximum requests per window
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests remaining in current window
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix timestamp when the window resets
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key with dtk_live_ prefix. Obtain it from API Keys in the account
        sidebar. New keys start with all supported scopes selected for the
        chosen project, and you can narrow them to specific read/write scopes as
        needed.

````