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

# Time-series visibility for a brand or all competitors



## OpenAPI

````yaml /api-reference/openapi.json get /visibility/trends
openapi: 3.1.0
info:
  title: OpenLens API
  version: 1.4.0
  description: >-
    Public REST API for OpenLens. Onboard clients, run scans across the major AI
    platforms, read visibility metrics, and download client-ready reports. Beta
    — endpoints may evolve before GA.
  contact:
    name: OpenLens support
    email: contact@aibread.com
servers:
  - url: https://openlens.com/api
security:
  - bearerAuth: []
tags:
  - name: Onboarding
  - name: Runs
  - name: Metrics
  - name: Citations
  - name: Deliverables
  - name: Resources
  - name: Account
  - name: Workstreams
paths:
  /visibility/trends:
    get:
      tags:
        - Metrics
      summary: Time-series visibility for a brand or all competitors
      parameters:
        - name: projectId
          in: query
          required: true
          schema:
            type: string
            format: uuid
          description: Project id. Required on all data endpoints.
        - name: brandId
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: topicId
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: platform
          in: query
          required: false
          schema:
            type: string
            enum:
              - chatgpt
              - chatgpt_app
              - claude
              - gemini
              - gemini_app
              - grok_app
              - grok_api
              - perplexity
              - perplexity_app
              - google_app
              - deepseek
            description: >-
              LLM platform identifier. Newer scraper-backed ids end in `_app`;
              `chatgpt`, `perplexity`, and `gemini` are legacy and not returned
              by current runs.
        - name: compare
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: >-
            When true, include `competitorSeries` for every non-own brand in the
            project.
        - name: days
          in: query
          required: false
          schema:
            type: integer
            default: 30
            minimum: 1
            maximum: 90
        - name: promptAttributes
          in: query
          required: false
          schema:
            type: string
          description: >-
            Comma-separated list of attribute filters. Accepts both built-in
            attributes (e.g. `pricing`, `comparisons`) and project-specific
            custom attributes.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  series:
                    type: array
                    items:
                      $ref: '#/components/schemas/TrendPoint'
                  competitorSeries:
                    type: array
                    items:
                      type: object
                      properties:
                        brandId:
                          type: string
                          format: uuid
                        brandName:
                          type: string
                        series:
                          type: array
                          items:
                            $ref: '#/components/schemas/TrendPoint'
                      required:
                        - brandId
                        - brandName
                        - series
                  summary:
                    $ref: '#/components/schemas/TrendSummary'
                required:
                  - series
                  - summary
        '400':
          description: Missing or invalid request parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, malformed, or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: >-
            Monthly included API calls for your tier are used up (code
            `USAGE_LIMIT`). Body includes a `limit` object — `{ limitHit,
            currentTier, targetTier, feature, cap, used, resetAt }` — describing
            the cap and the upgrade that lifts it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource not found or not owned by your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            Rate limit, project cap, or daily quota hit. Body includes a `code`
            field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error. Retry; if persistent, contact support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    TrendPoint:
      type: object
      properties:
        date:
          type: string
          format: date
        visibilityScore:
          type: number
        avgPosition:
          type: number
        mentionCount:
          type: integer
        citationCount:
          type: integer
        shareOfVoice:
          type: number
        sentimentScore:
          type: number
    TrendSummary:
      type: object
      properties:
        currentScore:
          type: number
        previousScore:
          type: number
        changePercent:
          type: number
        trend:
          type: string
          enum:
            - up
            - down
            - flat
      required:
        - currentScore
        - previousScore
        - changePercent
        - trend
    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: Stable machine code for programmatic handling, when applicable.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Clerk API key. Create one from your account settings under API Keys.

````