NUDG3 Insights & Actions API

The Insights & Actions API from NUDG3 — 9 operation(s) for insights & actions.

GitHub OpenAPI

Operations 10

GET /api/v1/reports/latest Get Latest Report #
GET /api/v1/reports List Reports #
GET /api/v1/reports/{report_id} Get Report Detail #
GET /api/v1/reports/{report_id}/insights Get Report Insights #
GET /api/v1/actions List Actions #
POST /api/v1/actions Create Action #
GET /api/v1/actions/{action_id} Get Action Detail #
POST /api/v1/actions/{action_id}/generate-brief Generate Brief #
POST /api/v1/actions/{action_id}/generate-content Generate Content #
GET /api/v1/actions/{action_id}/generation-status/{run_id} Get Generation Status #

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-insights-actions-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-insights-actions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 Insights & Actions 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: Insights & Actions
paths:
  /api/v1/reports/latest:
    get:
      tags:
      - Insights & Actions
      summary: Get Latest Report
      description: Get the most recent visibility report for this workspace.
      operationId: get_latest_report_api_v1_reports_latest_get
      security:
      - APIKeyHeader: []
      - APIKeyHeader: []
      parameters:
      - name: report_type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by report type
          title: Report Type
        description: Filter by report type
      - name: include_insights
        in: query
        required: false
        schema:
          type: boolean
          description: Include AI insights in response
          default: false
          title: Include Insights
        description: Include AI insights in response
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/reports:
    get:
      tags:
      - Insights & Actions
      summary: List Reports
      description: List visibility audit reports for this workspace.
      operationId: list_reports_api_v1_reports_get
      security:
      - APIKeyHeader: []
      - APIKeyHeader: []
      parameters:
      - name: report_type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by report type
          title: Report Type
        description: Filter by report type
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: Start date (YYYY-MM-DD)
          title: Start Date
        description: Start date (YYYY-MM-DD)
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: End date (YYYY-MM-DD)
          title: End Date
        description: End date (YYYY-MM-DD)
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number
          default: 1
          title: Page
        description: Page number
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          maximum: 50
          minimum: 1
          description: Results per page
          default: 20
          title: Per Page
        description: Results per page
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/reports/{report_id}:
    get:
      tags:
      - Insights & Actions
      summary: Get Report Detail
      description: Get full detail of a specific visibility report.
      operationId: get_report_detail_api_v1_reports__report_id__get
      security:
      - APIKeyHeader: []
      - APIKeyHeader: []
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Report Id
      - name: include_insights
        in: query
        required: false
        schema:
          type: boolean
          description: Include AI insights in response
          default: false
          title: Include Insights
        description: Include AI insights in response
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/reports/{report_id}/insights:
    get:
      tags:
      - Insights & Actions
      summary: Get Report Insights
      description: Get AI-generated insights from a visibility report.
      operationId: get_report_insights_api_v1_reports__report_id__insights_get
      security:
      - APIKeyHeader: []
      - APIKeyHeader: []
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Report Id
      - name: type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Filter: opportunities, threats, quick_wins, or all'
          title: Type
        description: 'Filter: opportunities, threats, quick_wins, or all'
      - name: priority
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Filter by priority: high, medium, low'
          title: Priority
        description: 'Filter by priority: high, medium, low'
      - name: category
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Filter by category: tech, content, marketing, leadership'
          title: Category
        description: 'Filter by category: tech, content, marketing, leadership'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/actions:
    get:
      tags:
      - Insights & Actions
      summary: List Actions
      description: List workspace actions with optional filters.
      operationId: list_actions_api_v1_actions_get
      security:
      - APIKeyHeader: []
      - APIKeyHeader: []
      parameters:
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by status
          title: Status
        description: Filter by status
      - name: priority
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by priority
          title: Priority
        description: Filter by priority
      - name: recommendation_type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by type
          title: Recommendation Type
        description: Filter by type
      - name: owner_team
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by team
          title: Owner Team
        description: Filter by team
      - name: content_format
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by content format
          title: Content Format
        description: Filter by content format
      - name: source_report_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by source report UUID
          title: Source Report Id
        description: Filter by source report UUID
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
          title: Page
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          maximum: 50
          minimum: 1
          default: 20
          title: Per Page
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Insights & Actions
      summary: Create Action
      description: Create a new workspace action.
      operationId: create_action_api_v1_actions_post
      security:
      - APIKeyHeader: []
      - APIKeyHeader: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas__api__public_api__insights__CreateActionRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/actions/{action_id}:
    get:
      tags:
      - Insights & Actions
      summary: Get Action Detail
      description: Get full detail of a specific action.
      operationId: get_action_detail_api_v1_actions__action_id__get
      security:
      - APIKeyHeader: []
      - APIKeyHeader: []
      parameters:
      - name: action_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Action Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/actions/{action_id}/generate-brief:
    post:
      tags:
      - Insights & Actions
      summary: Generate Brief
      description: 'Generate a content brief for an action. Rate limited: 5/action/hr, 50/workspace/day.'
      operationId: generate_brief_api_v1_actions__action_id__generate_brief_post
      security:
      - APIKeyHeader: []
      - APIKeyHeader: []
      parameters:
      - name: action_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Action Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateBriefRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/actions/{action_id}/generate-content:
    post:
      tags:
      - Insights & Actions
      summary: Generate Content
      description: 'Trigger async content generation for an action.


        Returns a run_id for polling via the generation-status endpoint.

        Rate limited: 5/action/hr, 50/workspace/day.'
      operationId: generate_content_api_v1_actions__action_id__generate_content_post
      security:
      - APIKeyHeader: []
      - APIKeyHeader: []
      parameters:
      - name: action_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Action Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas__api__public_api__insights__GenerateContentRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/actions/{action_id}/generation-status/{run_id}:
    get:
      tags:
      - Insights & Actions
      summary: Get Generation Status
      description: Poll content generation status. Returns content when completed.
      operationId: get_generation_status_api_v1_actions__action_id__generation_status__run_id__get
      security:
      - APIKeyHeader: []
      - APIKeyHeader: []
      parameters:
      - name: action_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Action Id
      - name: run_id
        in: path
        required: true
        schema:
          type: string
          title: Run Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    GenerateBriefRequest:
      properties:
        custom_instructions:
          anyOf:
          - type: string
            maxLength: 1000
          - type: 'null'
          title: Custom Instructions
          description: Custom instructions for brief generation
      type: object
      title: GenerateBriefRequest
      description: Request to generate a content brief for an action.
    schemas__api__public_api__insights__CreateActionRequest:
      properties:
        action_text:
          type: string
          maxLength: 2000
          minLength: 1
          title: Action Text
          description: Action description
        recommendation_type:
          type: string
          title: Recommendation Type
          description: opportunity, threat, quick_win, or prompt_edit
        priority:
          type: string
          title: Priority
          description: high, medium, or low
          default: medium
        content_format:
          anyOf:
          - type: string
          - type: 'null'
          title: Content Format
          description: blog_post, linkedin_post, x_thread, etc.
        target_platform:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Platform
          description: website, linkedin, x_twitter, etc.
        owner_team:
          anyOf:
          - type: string
          - type: 'null'
          title: Owner Team
          description: tech, content, marketing, or leadership
        source_report_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Report Id
          description: UUID of the source visibility report
        context:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Context
          description: Additional context for the action
      type: object
      required:
      - action_text
      - recommendation_type
      title: CreateActionRequest
      description: Request to create a new action.
    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
    schemas__api__public_api__insights__GenerateContentRequest:
      properties:
        use_brief:
          type: boolean
          title: Use Brief
          description: Use existing brief if available
          default: true
      type: object
      title: GenerateContentRequest
      description: Request to trigger async content generation for an action.
  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