NUDG3 Visibility Reports API

The Visibility Reports API from NUDG3 — 4 operation(s) for visibility reports.

GitHub OpenAPI

Operations 4

POST /workspace/{workspace_id}/visibility-reports/generate-weekly Generate Weekly Report #
GET /workspace/{workspace_id}/visibility-reports/ List Weekly Reports #
GET /workspace/{workspace_id}/visibility-reports/latest Get Latest Visibility Report #
GET /workspace/{workspace_id}/visibility-reports/{report_id} Get Weekly Report Details #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nudg3-ai:nudg3-ai-visibility-reports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nudg3-ai-visibility-reports-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 Visibility Reports API
  description: '# Nudg3 Brand Intelligence API


    The Nudg3 API provides programmatic access to brand visibility analytics across AI providers.


    ## Public API v1


    The Public API (`/api/v1/`) is designed for third-party integrations and provides:


    ### Analytics Endpoints (Tier 1 - Basic)

    - Brand visibility scores and trends

    - Sentiment analysis across AI responses

    - Source citation tracking

    - Prompt performance metrics

    - Google AI Overview (AIO) coverage


    ### Export Endpoints (Tier 2 - Premium)

    - Full response data exports (CSV/TSV)

    - Source citations bulk download

    - Dashboard time-series data

    - Prompt-mention pair exports


    ## Authentication


    ### API Key (Public API v1)

    ```bash

    curl -H "Authorization: Bearer nudg3_live_ak_xxx..." \

    https://api.nudg3.com/api/v1/dashboard

    ```


    ### JWT (Dashboard API)

    ```bash

    curl -H "Authorization: Bearer eyJ..." \

    https://api.nudg3.com/analytics/dashboard

    ```


    ## Rate Limits


    | Tier | Per Minute | Per Hour | Monthly Quota |

    |------|------------|----------|---------------|

    | Basic | 60 | 600 | 5,000 |

    | Premium | 300 | 3,000 | 50,000 |


    ## Response Format


    All responses follow a standard envelope:

    ```json

    {

    "success": true,

    "data": { ... },

    "message": "Success"

    }

    ```


    ## Support


    - Documentation: https://docs.nudg3.com

    - API Status: https://status.nudg3.com

    - Support: support@nudg3.com'
  version: 1.1.0
  termsOfService: https://nudg3.com/terms
  contact:
    name: Nudg3 API Support
    url: https://nudg3.com/support
    email: support@nudg3.com
  license:
    name: Proprietary
    url: https://nudg3.com/license
servers:
- url: https://api.nudg3.com
  description: Production API
- url: https://api-staging.nudg3.com
  description: Staging API (for testing)
- url: http://localhost:8000
  description: Local Development
tags:
- name: Visibility Reports
paths:
  /workspace/{workspace_id}/visibility-reports/generate-weekly:
    post:
      tags:
      - Visibility Reports
      summary: Generate Weekly Report
      description: 'Generate a weekly visibility report for a workspace.


        Analyzes all provider responses within the specified date range and generates

        AI-powered insights using the visibility_analysis workflow.


        This endpoint:

        1. Validates date range (max 14 days)

        2. Checks quota availability (deducts from manual trigger quota for Sonnet)

        3. Triggers LangGraph workflow with date-range parameters

        4. Returns request_id for status polling


        Args:

        workspace_id: Workspace UUID

        request: Report generation parameters

        current_user: Authenticated user

        db: Database session


        Returns:

        Generation status with request_id'
      operationId: generate_weekly_report_workspace__workspace_id__visibility_reports_generate_weekly_post
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateWeeklyReportRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateWeeklyReportResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /workspace/{workspace_id}/visibility-reports/:
    get:
      tags:
      - Visibility Reports
      summary: List Weekly Reports
      description: 'List weekly visibility reports for a workspace.


        Returns reports sorted by creation date (newest first). Includes both

        single-day reports (legacy) and date-range reports (weekly).


        Args:

        workspace_id: Workspace UUID

        limit: Max number of reports to return

        offset: Number of reports to skip (for pagination)

        current_user: Authenticated user

        db: Database session


        Returns:

        List of report summaries'
      operationId: list_weekly_reports_workspace__workspace_id__visibility_reports__get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Number of reports to return
          default: 10
          title: Limit
        description: Number of reports to return
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Number of reports to skip
          default: 0
          title: Offset
        description: Number of reports to skip
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WeeklyReportSummary'
                title: Response List Weekly Reports Workspace  Workspace Id  Visibility Reports  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /workspace/{workspace_id}/visibility-reports/latest:
    get:
      tags:
      - Visibility Reports
      summary: Get Latest Visibility Report
      description: 'Get the most recent visibility report for a workspace.


        Returns the latest report with full details including AI insights.

        Returns 204 No Content if no reports exist yet.


        Args:

        workspace_id: Workspace UUID

        current_user: Authenticated user

        db: Database session


        Returns:

        Latest report data or 204 if none exist'
      operationId: get_latest_visibility_report_workspace__workspace_id__visibility_reports_latest_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      responses:
        '200':
          description: Latest visibility report
          content:
            application/json:
              schema: {}
        '204':
          description: No reports exist for this workspace
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /workspace/{workspace_id}/visibility-reports/{report_id}:
    get:
      tags:
      - Visibility Reports
      summary: Get Weekly Report Details
      description: 'Get detailed visibility report by ID.


        Returns full report data including AI insights, metrics, and analysis context.


        Args:

        workspace_id: Workspace UUID

        report_id: Report UUID

        current_user: Authenticated user

        db: Database session


        Returns:

        Complete report data'
      operationId: get_weekly_report_details_workspace__workspace_id__visibility_reports__report_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Report Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Weekly Report Details Workspace  Workspace Id  Visibility Reports  Report Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    GenerateWeeklyReportResponse:
      properties:
        request_id:
          type: string
          title: Request Id
        status:
          type: string
          title: Status
        message:
          type: string
          title: Message
        workflow_run_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Workflow Run Id
        model_used:
          type: string
          title: Model Used
        start_date:
          type: string
          title: Start Date
        end_date:
          type: string
          title: End Date
        quota_remaining:
          type: integer
          title: Quota Remaining
      type: object
      required:
      - request_id
      - status
      - message
      - workflow_run_id
      - model_used
      - start_date
      - end_date
      - quota_remaining
      title: GenerateWeeklyReportResponse
      description: Response for weekly report generation request.
    WeeklyReportSummary:
      properties:
        report_id:
          type: string
          title: Report Id
        workspace_id:
          type: string
          title: Workspace Id
        start_date:
          type: string
          title: Start Date
        end_date:
          type: string
          title: End Date
        analysis_period:
          type: string
          title: Analysis Period
        visibility_score:
          anyOf:
          - type: integer
          - type: 'null'
          title: Visibility Score
        audit_score:
          anyOf:
          - type: integer
          - type: 'null'
          title: Audit Score
        total_responses:
          type: integer
          title: Total Responses
        total_mentions:
          type: integer
          title: Total Mentions
        competitive_position:
          anyOf:
          - type: integer
          - type: 'null'
          title: Competitive Position
        model_used:
          type: string
          title: Model Used
        created_at:
          type: string
          title: Created At
      type: object
      required:
      - report_id
      - workspace_id
      - start_date
      - end_date
      - analysis_period
      - visibility_score
      - audit_score
      - total_responses
      - total_mentions
      - competitive_position
      - model_used
      - created_at
      title: WeeklyReportSummary
      description: Summary of a weekly visibility report.
    GenerateWeeklyReportRequest:
      properties:
        start_date:
          type: string
          format: date
          title: Start Date
          description: Start date for analysis (ISO format)
        end_date:
          type: string
          format: date
          title: End Date
          description: End date for analysis (ISO format)
        model_tier:
          anyOf:
          - type: string
          - type: 'null'
          title: Model Tier
          description: Override model tier for report generation
        analysis_period:
          type: string
          title: Analysis Period
          description: Report period type
          default: weekly
      type: object
      required:
      - start_date
      - end_date
      title: GenerateWeeklyReportRequest
      description: Request body for generating weekly visibility report.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: '

        API Key authentication for Public API v1 endpoints.


        **Format:** `nudg3_live_ak_xxx...` or `nudg3_test_ak_xxx...`


        **Usage:**

        ```

        Authorization: Bearer nudg3_live_ak_your_key_here

        ```


        Or use the header:

        ```

        X-API-Key: nudg3_live_ak_your_key_here

        ```


        **Obtain API Keys:**

        Generate API keys from your Nudg3 dashboard under Settings > API Keys.


        **Tiers:**

        - **Basic:** `read:analytics` scope - Analytics endpoints only

        - **Premium:** `read:analytics` + `export:data` scopes - Analytics + Exports

        '
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: '

        JWT authentication for internal dashboard endpoints.


        Obtain tokens via `/auth/login` endpoint.

        '
externalDocs:
  description: Nudg3 API Documentation
  url: https://docs.nudg3.com/api