> ## 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 competitive positioning data

> Returns citation comparison between primary, competitor, and other sources over time for a fixed rolling window. The default includes only currently active project platforms.



## OpenAPI

````yaml /openapi.json get /projects/{projectId}/competitive/position
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}/competitive/position:
    get:
      summary: Get competitive positioning data
      description: >-
        Returns citation comparison between primary, competitor, and other
        sources over time for a fixed rolling window. The default includes only
        currently active project platforms.
      operationId: getCompetitivePosition
      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: grouping
          in: query
          schema:
            type: string
            enum:
              - daily
              - weekly
              - monthly
            default: daily
        - 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: Competitive positioning data
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      timeSeries:
                        type: array
                        description: >-
                          Points for platforms in the daily series, grouped by
                          the requested period. A request for one weekly
                          platform returns a point per run.
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              format: date
                            primaryCitations:
                              type: integer
                            competitorCitations:
                              type: integer
                            otherCitations:
                              type: integer
                      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
                      totals:
                        type: object
                        description: >-
                          Window totals across every platform in scope,
                          including weekly ones.
                        properties:
                          primaryCitations:
                            type: integer
                          competitorCitations:
                            type: integer
                          otherCitations:
                            type: integer
                          total:
                            type: integer
                          primaryShare:
                            type: number
                            minimum: 0
                            maximum: 100
                            description: >-
                              Percent share of total citations attributed to the
                              primary brand, expressed on a 0-100 scale.
                          primaryShareOfAllCitations:
                            type: number
                            minimum: 0
                            maximum: 100
                            description: >-
                              Percent share of primary, competitor, and other
                              citations attributed to the primary brand.
                          shareOfVoice:
                            type: number
                            minimum: 0
                            maximum: 100
                            description: >-
                              Percent share of primary and competitor citations
                              attributed to the primary brand.
                  meta:
                    $ref: '#/components/schemas/Meta'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '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:
    BadRequestError:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    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.