NUDG3 Admin - Extraction Queue API

The Admin - Extraction Queue API from NUDG3 — 7 operation(s) for admin - extraction queue.

GitHub OpenAPI

Operations 7

GET /admin/extraction-queue/stats Get Queue Stats #
GET /admin/extraction-queue/dlq List Dlq Jobs #
POST /admin/extraction-queue/dlq/{job_id}/retry Retry Dlq Job #
DELETE /admin/extraction-queue/dlq/{job_id} Delete Dlq Job #
POST /admin/extraction-queue/dlq/retry-all Retry All Dlq Jobs #
POST /admin/extraction-queue/ping Ping Queue #
POST /admin/extraction-queue/reset-circuit-breaker Reset Circuit Breaker #

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-admin-extraction-queue-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-admin-extraction-queue-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 Admin - Extraction Queue 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: Admin - Extraction Queue
paths:
  /admin/extraction-queue/stats:
    get:
      tags:
      - Admin - Extraction Queue
      summary: Get Queue Stats
      description: 'Get extraction queue statistics and health status.


        Returns queue depths, daily metrics, circuit breaker status, and health warnings.


        Health Thresholds:

        - DLQ > 5: Warning

        - DLQ > 20: Critical

        - Pending > 100: Warning

        - Pending > 500: Critical

        - Processing > 50: Warning (possible worker issues)'
      operationId: get_queue_stats_admin_extraction_queue_stats_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueStatsResponse'
      security:
      - HTTPBearer: []
  /admin/extraction-queue/dlq:
    get:
      tags:
      - Admin - Extraction Queue
      summary: List Dlq Jobs
      description: 'List jobs in the dead letter queue.


        Returns failed extraction jobs that have exhausted all retry attempts.

        These require manual intervention to resolve.'
      operationId: list_dlq_jobs_admin_extraction_queue_dlq_get
      security:
      - HTTPBearer: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          description: Maximum jobs to return
          default: 50
          title: Limit
        description: Maximum jobs to return
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLQListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/extraction-queue/dlq/{job_id}/retry:
    post:
      tags:
      - Admin - Extraction Queue
      summary: Retry Dlq Job
      description: 'Retry a failed job from the dead letter queue.


        Moves the job back to the pending queue with reset retry count.

        Use this after resolving the underlying issue.'
      operationId: retry_dlq_job_admin_extraction_queue_dlq__job_id__retry_post
      security:
      - HTTPBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/extraction-queue/dlq/{job_id}:
    delete:
      tags:
      - Admin - Extraction Queue
      summary: Delete Dlq Job
      description: 'Delete a job from the dead letter queue.


        Use this when the job is no longer needed or the issue has been

        resolved through other means.'
      operationId: delete_dlq_job_admin_extraction_queue_dlq__job_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/extraction-queue/dlq/retry-all:
    post:
      tags:
      - Admin - Extraction Queue
      summary: Retry All Dlq Jobs
      description: 'Retry all jobs in the dead letter queue.


        Moves up to max_jobs from DLQ back to pending queue.

        Use with caution - ensure the underlying issues are resolved first.'
      operationId: retry_all_dlq_jobs_admin_extraction_queue_dlq_retry_all_post
      security:
      - HTTPBearer: []
      parameters:
      - name: max_jobs
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          description: Maximum jobs to retry
          default: 100
          title: Max Jobs
        description: Maximum jobs to retry
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/extraction-queue/ping:
    post:
      tags:
      - Admin - Extraction Queue
      summary: Ping Queue
      description: 'Ping the extraction queue Redis connection.


        Use this to verify Redis connectivity.'
      operationId: ping_queue_admin_extraction_queue_ping_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResponse'
      security:
      - HTTPBearer: []
  /admin/extraction-queue/reset-circuit-breaker:
    post:
      tags:
      - Admin - Extraction Queue
      summary: Reset Circuit Breaker
      description: 'Manually reset the circuit breaker.


        Use this after resolving Redis connectivity issues to immediately

        restore normal operation without waiting for the timeout.'
      operationId: reset_circuit_breaker_admin_extraction_queue_reset_circuit_breaker_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResponse'
      security:
      - HTTPBearer: []
components:
  schemas:
    DLQListResponse:
      properties:
        total:
          type: integer
          title: Total
        jobs:
          items:
            $ref: '#/components/schemas/DLQJobResponse'
          type: array
          title: Jobs
      type: object
      required:
      - total
      - jobs
      title: DLQListResponse
      description: List of DLQ jobs response.
    QueueStatsResponse:
      properties:
        pending:
          type: integer
          title: Pending
          description: Jobs waiting to be processed
        processing:
          type: integer
          title: Processing
          description: Jobs currently being processed
        delayed:
          type: integer
          title: Delayed
          description: Jobs waiting for retry
        dlq:
          type: integer
          title: Dlq
          description: Jobs in dead letter queue
        processed_today:
          type: integer
          title: Processed Today
          description: Successfully processed jobs today
        failed_today:
          type: integer
          title: Failed Today
          description: Failed jobs today
        avg_retry_count:
          type: number
          title: Avg Retry Count
          description: Average retry count for DLQ jobs
        circuit_breaker:
          additionalProperties: true
          type: object
          title: Circuit Breaker
          description: Circuit breaker status
        is_healthy:
          type: boolean
          title: Is Healthy
          description: Overall queue health status
        warnings:
          items:
            type: string
          type: array
          title: Warnings
          description: Health warnings
      type: object
      required:
      - pending
      - processing
      - delayed
      - dlq
      - processed_today
      - failed_today
      - avg_retry_count
      - circuit_breaker
      - is_healthy
      title: QueueStatsResponse
      description: Queue statistics response.
    DLQJobResponse:
      properties:
        job_id:
          type: string
          title: Job Id
        batch_job_id:
          type: string
          title: Batch Job Id
        workspace_id:
          type: string
          title: Workspace Id
        collection_run_id:
          type: string
          title: Collection Run Id
        response_count:
          type: integer
          title: Response Count
        reservation_key:
          anyOf:
          - type: string
          - type: 'null'
          title: Reservation Key
        retry_count:
          type: integer
          title: Retry Count
        max_retries:
          type: integer
          title: Max Retries
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
        first_attempt_at:
          anyOf:
          - type: string
          - type: 'null'
          title: First Attempt At
        last_attempt_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Attempt At
        error_history:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Error History
        total_elapsed_minutes:
          anyOf:
          - type: number
          - type: 'null'
          title: Total Elapsed Minutes
          description: Minutes since job was created
      type: object
      required:
      - job_id
      - batch_job_id
      - workspace_id
      - collection_run_id
      - response_count
      - reservation_key
      - retry_count
      - max_retries
      - created_at
      - first_attempt_at
      - last_attempt_at
      - error_history
      title: DLQJobResponse
      description: Dead letter queue job 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
    OperationResponse:
      properties:
        status:
          type: string
          title: Status
        message:
          type: string
          title: Message
        job_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Job Id
      type: object
      required:
      - status
      - message
      title: OperationResponse
      description: Generic operation response.
  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