> ## 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 visibility summary metrics

> Returns share of voice, presence rate, brand mentions, and citation statistics. The default scope includes only platforms currently active for the project.



## OpenAPI

````yaml /openapi.json get /projects/{projectId}/visibility/summary
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}/visibility/summary:
    get:
      summary: Get visibility summary metrics
      description: >-
        Returns share of voice, presence rate, brand mentions, and citation
        statistics. The default scope includes only platforms currently active
        for the project.
      operationId: getVisibilitySummary
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: windowDays
          in: query
          schema:
            type: integer
            enum:
              - 30
              - 90
            default: 30
          description: >-
            Fixed rolling window in days. Supported values are 30 and 90.
            Defaults to 30.
        - name: platform
          in: query
          schema:
            type: string
        - name: topicId
          in: query
          schema:
            type: string
            format: uuid
        - name: includeHistoricalPlatforms
          in: query
          description: >-
            Allow a requested inactive platform to return historical data.
            Defaults to false.
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Visibility summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      totalExecutions:
                        type: integer
                      shareOfVoice:
                        type:
                          - number
                          - 'null'
                        minimum: 0
                        maximum: 100
                        description: >-
                          Percent share of primary plus tracked competitor
                          citations attributed to the primary brand. Null when
                          no response has usable citation data.
                      citationPresence:
                        type:
                          - number
                          - 'null'
                        minimum: 0
                        maximum: 100
                        description: >-
                          Percent of citation-eligible tracked prompts where the
                          primary brand or tracked URLs were cited. Null when no
                          response has usable citation data.
                      brandAwareness:
                        type: number
                        minimum: 0
                        maximum: 100
                        description: >-
                          Percent of tracked prompts where the primary brand was
                          mentioned or cited, expressed on a 0-100 scale.
                      avgPrimaryPosition:
                        type:
                          - number
                          - 'null'
                      primaryCitations:
                        type: integer
                      competitorCitations:
                        type: integer
                      advertising:
                        type: object
                        description: >-
                          Forward-only ads detected in captured responses.
                          Missing fields and unsupported platforms are
                          unmeasured. Rates use measuredResponses as the
                          denominator, independently of organic Presence.
                        properties:
                          responses:
                            type: integer
                          measuredResponses:
                            type: integer
                          primaryResponses:
                            type: integer
                          competitorResponses:
                            type: integer
                          adResponses:
                            type: integer
                          primaryRate:
                            type:
                              - number
                              - 'null'
                            minimum: 0
                            maximum: 1
                          competitorRate:
                            type:
                              - number
                              - 'null'
                            minimum: 0
                            maximum: 1
                      measurement:
                        type: object
                        properties:
                          scope:
                            type: string
                            enum:
                              - current_active
                              - requested
                          requestedPlatform:
                            type:
                              - string
                              - 'null'
                          configurationStatus:
                            type: string
                            enum:
                              - active_set
                              - active
                              - inactive
                              - not_configured
                              - unknown
                          dataStatus:
                            type: string
                            description: >-
                              Measurement state for the requested scope. no_data
                              means the platform was not measured in the window,
                              not that measured visibility was zero.
                            enum:
                              - measured
                              - no_data
                              - historical
                              - historical_available
                          historicalDataAvailable:
                            type: boolean
                          activePlatforms:
                            type: array
                            description: >-
                              Platforms currently enabled for this project. Use
                              this list for current per-platform reporting.
                            items:
                              type: string
                          measuredPlatforms:
                            type: array
                            description: >-
                              Platforms with execution data in the window,
                              including inactive historical platforms.
                            items:
                              type: string
                          reportablePlatforms:
                            type: array
                            description: >-
                              Currently enabled platforms with measured
                              execution data in the window. Use this list for
                              current per-platform reporting; configured
                              onboarding platforms without measurements are
                              excluded.
                            items:
                              type: string
                      platformCadences:
                        type:
                          - array
                          - 'null'
                        description: >-
                          Cadence of each platform in scope. Platforms with
                          inDailySeries false are checked less often than daily:
                          window totals include them, and timeSeries leaves them
                          out unless they are the only platforms in scope. Null
                          when cadence could not be read.
                        items:
                          type: object
                          properties:
                            platform:
                              type: string
                            cadenceDays:
                              type: integer
                              minimum: 1
                              description: Days between scheduled checks.
                            inDailySeries:
                              type: boolean
                              description: >-
                                Whether the platform joins daily cross-platform
                                totals.
                            lastCheckedOn:
                              type:
                                - string
                                - 'null'
                              format: date
                              description: >-
                                Last date with responses, for platforms outside
                                the daily series. Null for daily platforms, and
                                for weekly platforms not checked in the last
                                year.
                          required:
                            - platform
                            - cadenceDays
                            - inDailySeries
                            - lastCheckedOn
                  meta:
                    $ref: '#/components/schemas/Meta'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '429':
          $ref: '#/components/responses/RateLimitExceededError'
components:
  schemas:
    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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.