NUDG3 Usage Tracking API

The Usage Tracking API from NUDG3 — 2 operation(s) for usage tracking.

GitHub OpenAPI

Operations 2

GET /workspace/{workspace_id}/usage Get current usage statistics for workspace #
GET /workspace/{workspace_id}/trial-status Get trial status for workspace #

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-usage-tracking-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-usage-tracking-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 Usage Tracking 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: Usage Tracking
paths:
  /workspace/{workspace_id}/usage:
    get:
      tags:
      - Usage Tracking
      summary: Get current usage statistics for workspace
      description: 'Retrieve current daily usage statistics for a workspace.


        Returns:

        - Daily limit based on subscription plan

        - Current usage for today

        - Remaining prompts available

        - Utilization percentage

        - Subscription and trial status


        **Use Case**: Display usage meter in dashboard, show warnings when approaching limit


        **Rate Limiting**: None (read-only endpoint)'
      operationId: get_workspace_usage_workspace__workspace_id__usage_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /workspace/{workspace_id}/trial-status:
    get:
      tags:
      - Usage Tracking
      summary: Get trial status for workspace
      description: 'Retrieve detailed trial status information for a workspace.


        Returns:

        - Whether workspace is currently on trial

        - Whether trial has expired (using database-level NOW() check)

        - Trial end date

        - Days remaining in trial

        - Active subscription status


        **Use Case**: Display trial banners, upgrade prompts, expiration warnings


        **Rate Limiting**: None (read-only endpoint)'
      operationId: get_trial_status_workspace__workspace_id__trial_status_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api__usage__TrialStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    api__usage__TrialStatusResponse:
      properties:
        workspace_id:
          type: string
          title: Workspace Id
          description: UUID of the workspace
        is_trial:
          type: boolean
          title: Is Trial
          description: Whether workspace is on trial
        trial_expired:
          type: boolean
          title: Trial Expired
          description: Whether trial has expired
        trial_end_date:
          anyOf:
          - type: string
          - type: 'null'
          title: Trial End Date
          description: Trial end date (ISO format)
        days_remaining:
          anyOf:
          - type: integer
          - type: 'null'
          title: Days Remaining
          description: Days remaining in trial
        has_subscription:
          type: boolean
          title: Has Subscription
          description: Whether workspace has active subscription
      type: object
      required:
      - workspace_id
      - is_trial
      - trial_expired
      - has_subscription
      title: TrialStatusResponse
      description: Response model for trial status information.
    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
    UsageResponse:
      properties:
        workspace_id:
          type: string
          title: Workspace Id
          description: UUID of the workspace
        daily_limit:
          type: integer
          title: Daily Limit
          description: Maximum prompts allowed per day
        daily_usage:
          type: integer
          title: Daily Usage
          description: Prompts used today
        remaining:
          type: integer
          title: Remaining
          description: Prompts remaining for today
        utilization_percent:
          type: number
          title: Utilization Percent
          description: Percentage of daily limit used
        date:
          type: string
          title: Date
          description: Date for usage calculation (ISO format)
        subscription_status:
          type: string
          title: Subscription Status
          description: Current subscription status
        trial_status:
          anyOf:
          - type: string
          - type: 'null'
          title: Trial Status
          description: Trial status if applicable
        quota_sources:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Quota Sources
          description: Sources of quota allocation (subscription, agency_pool, trial, add_on)
        is_unlimited:
          type: boolean
          title: Is Unlimited
          description: Whether workspace has unlimited quota
          default: false
        quota_breakdown:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Quota Breakdown
          description: Detailed breakdown of quota allocations
      type: object
      required:
      - workspace_id
      - daily_limit
      - daily_usage
      - remaining
      - utilization_percent
      - date
      - subscription_status
      title: UsageResponse
      description: Response model for workspace usage information.
  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