NUDG3 Dashboard Exports API

The Dashboard Exports API from NUDG3 — 4 operation(s) for dashboard exports.

GitHub OpenAPI

Operations 4

GET /workspace/{workspace_id}/exports/dashboard-graph Export dashboard graph data to CSV #
GET /workspace/{workspace_id}/exports/dashboard-graph/statistics Get dashboard export statistics #
GET /workspace/{workspace_id}/exports/dashboard-graph/manifest Get dashboard export manifest #
GET /workspace/{workspace_id}/exports/dashboard-graph/schema Get dashboard export schema #

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-dashboard-exports-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-dashboard-exports-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 Dashboard Exports 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: Dashboard Exports
paths:
  /workspace/{workspace_id}/exports/dashboard-graph:
    get:
      tags:
      - Dashboard Exports
      summary: Export dashboard graph data to CSV
      description: 'Export the underlying data used to generate the dashboard brand visibility graph.


        Supports multiple export formats:

        - **timeseries**: Daily visibility data for each brand (one row per brand per day)

        - **summary**: Aggregated brand metrics over the date range (one row per brand)

        - **combined**: Both timeseries and summary data in a ZIP file with two CSVs


        The exported CSV respects all dashboard filters currently applied.'
      operationId: export_dashboard_graph_workspace__workspace_id__exports_dashboard_graph_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Workspace ID
          title: Workspace Id
        description: Workspace ID
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date (YYYY-MM-DD)
          title: Start Date
        description: Start date (YYYY-MM-DD)
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: End date (YYYY-MM-DD)
          title: End Date
        description: End date (YYYY-MM-DD)
      - name: export_type
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/DashboardExportType'
          description: Export format type
          default: timeseries
        description: Export format type
      - name: models
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by AI models
          title: Models
        description: Filter by AI models
      - name: tags
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by prompt template tags
          title: Tags
        description: Filter by prompt template tags
      responses:
        '200':
          description: CSV file download
          content:
            text/csv: {}
        '400':
          description: Invalid parameters
        '403':
          description: Insufficient permissions
        '404':
          description: Workspace not found
        '503':
          description: Service temporarily unavailable
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /workspace/{workspace_id}/exports/dashboard-graph/statistics:
    get:
      tags:
      - Dashboard Exports
      summary: Get dashboard export statistics
      description: Get statistics about the dashboard data that would be exported without generating the actual export.
      operationId: get_dashboard_export_statistics_workspace__workspace_id__exports_dashboard_graph_statistics_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Workspace ID
          title: Workspace Id
        description: Workspace ID
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date (YYYY-MM-DD)
          title: Start Date
        description: Start date (YYYY-MM-DD)
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: End date (YYYY-MM-DD)
          title: End Date
        description: End date (YYYY-MM-DD)
      - name: export_type
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/DashboardExportType'
          description: Export format type
          default: timeseries
        description: Export format type
      - name: models
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by AI models
          title: Models
        description: Filter by AI models
      - name: tags
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by prompt template tags
          title: Tags
        description: Filter by prompt template tags
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardExportStatistics'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /workspace/{workspace_id}/exports/dashboard-graph/manifest:
    get:
      tags:
      - Dashboard Exports
      summary: Get dashboard export manifest
      description: Get manifest metadata for dashboard export (JSON format)
      operationId: get_dashboard_export_manifest_workspace__workspace_id__exports_dashboard_graph_manifest_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Workspace ID
          title: Workspace Id
        description: Workspace ID
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date (YYYY-MM-DD)
          title: Start Date
        description: Start date (YYYY-MM-DD)
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: End date (YYYY-MM-DD)
          title: End Date
        description: End date (YYYY-MM-DD)
      - name: export_type
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/DashboardExportType'
          description: Export format type
          default: timeseries
        description: Export format type
      - name: models
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by AI models
          title: Models
        description: Filter by AI models
      - name: tags
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by prompt template tags
          title: Tags
        description: Filter by prompt template tags
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Dashboard Export Manifest Workspace  Workspace Id  Exports Dashboard Graph Manifest Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /workspace/{workspace_id}/exports/dashboard-graph/schema:
    get:
      tags:
      - Dashboard Exports
      summary: Get dashboard export schema
      description: Get schema documentation for dashboard export CSV (Markdown format)
      operationId: get_dashboard_schema_endpoint_workspace__workspace_id__exports_dashboard_graph_schema_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Workspace ID
          title: Workspace Id
        description: Workspace ID
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date (YYYY-MM-DD)
          title: Start Date
        description: Start date (YYYY-MM-DD)
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: End date (YYYY-MM-DD)
          title: End Date
        description: End date (YYYY-MM-DD)
      - name: export_type
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/DashboardExportType'
          description: Export format type
          default: timeseries
        description: Export format type
      - name: models
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by AI models
          title: Models
        description: Filter by AI models
      - name: tags
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by prompt template tags
          title: Tags
        description: Filter by prompt template tags
      responses:
        '200':
          description: Markdown schema file
          content:
            text/markdown: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DashboardExportType:
      type: string
      enum:
      - timeseries
      - summary
      - combined
      title: DashboardExportType
      description: Export format types for dashboard data.
    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
    DashboardExportStatistics:
      properties:
        total_brands:
          type: integer
          title: Total Brands
          description: Total number of brands in export
        total_data_points:
          type: integer
          title: Total Data Points
          description: Total number of data rows in export
        date_range_days:
          type: integer
          title: Date Range Days
          description: Number of days in date range
        estimated_size_mb:
          type: number
          title: Estimated Size Mb
          description: Estimated export file size in MB
      type: object
      required:
      - total_brands
      - total_data_points
      - date_range_days
      - estimated_size_mb
      title: DashboardExportStatistics
      description: Response model for dashboard export statistics.
  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