NUDG3 Analytics - Narrative Alignment API

The Analytics - Narrative Alignment API from NUDG3 — 3 operation(s) for analytics - narrative alignment.

GitHub OpenAPI

Operations 3

GET /analytics/narrative-alignment Get Narrative Alignment #
GET /analytics/narrative-alignment/narratives List Narratives #
GET /analytics/narrative-alignment/narratives/{narrative_id} Get Narrative Detail #

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-analytics-narrative-alignment-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-analytics-narrative-alignment-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 Analytics - Narrative Alignment 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: Analytics - Narrative Alignment
paths:
  /analytics/narrative-alignment:
    get:
      tags:
      - Analytics - Narrative Alignment
      summary: Get Narrative Alignment
      description: 'Latest narrative-alignment run for a workspace.


        Response data (SuccessResponse envelope):

        status "ready" | "no_data"

        alignment_score per-response: 1 - (applicable responses with >=1

        misalignment / applicable responses). None if no run.

        methodology_version "v0" (surfaced in the TP-transparency footer)

        tp_rate_estimate "~70-75%"

        total_findings all (response x fixture) rows in the run

        total_misalignments detected findings (fires)

        latest_run run metadata (judge_model, cohort, cost, etc.)

        by_family [{family, fires}] summary of detections

        misalignments [{fixture_external_id, family, response_id, provider,

        funnel_stage, confidence, rationale}] (capped)

        boosters [{family, booster_type, title, draft_text,

        rubric_score, status, target_fixture_id}]'
      operationId: get_narrative_alignment_analytics_narrative_alignment_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: query
        required: true
        schema:
          type: string
          format: uuid
          description: Workspace ID (mandatory for all analytics endpoints)
          title: Workspace Id
        description: Workspace ID (mandatory for all analytics endpoints)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /analytics/narrative-alignment/narratives:
    get:
      tags:
      - Analytics - Narrative Alignment
      summary: List Narratives
      description: 'Curated narratives for a workspace, worst-aligned first.


        Each row is a persistent narrative (aligned_narratives) with its rolling

        alignment / state / provider-funnel skew. Feeds the Dashboard tiles.

        Sentiment + mention-volume fields may be null until the brand_mention

        classification pass runs (a later increment).'
      operationId: list_narratives_analytics_narrative_alignment_narratives_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: query
        required: true
        schema:
          type: string
          format: uuid
          description: Workspace ID (mandatory for all analytics endpoints)
          title: Workspace Id
        description: Workspace ID (mandatory for all analytics endpoints)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /analytics/narrative-alignment/narratives/{narrative_id}:
    get:
      tags:
      - Analytics - Narrative Alignment
      summary: Get Narrative Detail
      description: 'Detail for one narrative: metadata, event timeline, exemplar

        misalignments (fires only, capped), and boosters targeting its fixtures.'
      operationId: get_narrative_detail_analytics_narrative_alignment_narratives__narrative_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: narrative_id
        in: path
        required: true
        schema:
          type: string
          title: Narrative Id
      - name: workspace_id
        in: query
        required: true
        schema:
          type: string
          format: uuid
          description: Workspace ID (mandatory for all analytics endpoints)
          title: Workspace Id
        description: Workspace ID (mandatory for all analytics endpoints)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SuccessResponse:
      properties:
        status:
          type: string
          title: Status
          description: Response status
          default: success
        message:
          type: string
          title: Message
        data:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Data
      type: object
      required:
      - message
      title: SuccessResponse
      description: Generic success response.
    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