NUDG3 Admin - Quotas API
The Admin - Quotas API from NUDG3 — 8 operation(s) for admin - quotas.
The Admin - Quotas API from NUDG3 — 8 operation(s) for admin - quotas.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/nudg3-ai:nudg3-ai-admin-quotas-api"
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.
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: 3.2.0
info:
title: Nudg3 Admin - Quotas 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 - Quotas
paths:
/admin/plans/{plan_id}/quotas:
get:
tags:
- Admin - Quotas
summary: Get plan quotas
description: Get all quota configurations for a subscription plan.
operationId: get_plan_quotas_admin_plans__plan_id__quotas_get
security:
- HTTPBearer: []
parameters:
- name: plan_id
in: path
required: true
schema:
type: string
format: uuid
title: Plan Id
- name: include_inactive
in: query
required: false
schema:
type: boolean
description: Include inactive quotas
default: false
title: Include Inactive
description: Include inactive quotas
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PlanQuotaResponse'
title: Response Get Plan Quotas Admin Plans Plan Id Quotas Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- Admin - Quotas
summary: Create plan quota
description: Add a quota configuration to a subscription plan.
operationId: create_plan_quota_admin_plans__plan_id__quotas_post
security:
- HTTPBearer: []
parameters:
- name: plan_id
in: path
required: true
schema:
type: string
format: uuid
title: Plan Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePlanQuotaRequest'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PlanQuotaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/admin/plans/{plan_id}/quotas/{quota_id}:
patch:
tags:
- Admin - Quotas
summary: Update plan quota
description: Update a quota configuration for a subscription plan.
operationId: update_plan_quota_admin_plans__plan_id__quotas__quota_id__patch
security:
- HTTPBearer: []
parameters:
- name: plan_id
in: path
required: true
schema:
type: string
format: uuid
title: Plan Id
- name: quota_id
in: path
required: true
schema:
type: string
format: uuid
title: Quota Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePlanQuotaRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PlanQuotaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Admin - Quotas
summary: Delete plan quota
description: Remove a quota configuration from a subscription plan.
operationId: delete_plan_quota_admin_plans__plan_id__quotas__quota_id__delete
security:
- HTTPBearer: []
parameters:
- name: plan_id
in: path
required: true
schema:
type: string
format: uuid
title: Plan Id
- name: quota_id
in: path
required: true
schema:
type: string
format: uuid
title: Quota Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/admin/plans/{plan_id}/quotas/bulk:
post:
tags:
- Admin - Quotas
summary: Bulk create plan quotas
description: Create multiple quota configurations for a plan at once.
operationId: bulk_create_plan_quotas_admin_plans__plan_id__quotas_bulk_post
security:
- HTTPBearer: []
parameters:
- name: plan_id
in: path
required: true
schema:
type: string
format: uuid
title: Plan Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BulkCreatePlanQuotasRequest'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PlanQuotaResponse'
title: Response Bulk Create Plan Quotas Admin Plans Plan Id Quotas Bulk Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/admin/agencies/{agency_id}/quota-pools:
get:
tags:
- Admin - Quotas
summary: Get agency quota pools
description: Get all quota pools for an agency.
operationId: get_agency_pools_admin_agencies__agency_id__quota_pools_get
security:
- HTTPBearer: []
parameters:
- name: agency_id
in: path
required: true
schema:
type: string
format: uuid
title: Agency Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/api__admin__quotas__AgencyPoolResponse'
title: Response Get Agency Pools Admin Agencies Agency Id Quota Pools Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- Admin - Quotas
summary: Create agency quota pool
description: Create a new quota pool for an agency.
operationId: create_agency_pool_admin_agencies__agency_id__quota_pools_post
security:
- HTTPBearer: []
parameters:
- name: agency_id
in: path
required: true
schema:
type: string
format: uuid
title: Agency Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/api__admin__quotas__CreateAgencyPoolRequest'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/api__admin__quotas__AgencyPoolResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/admin/agencies/{agency_id}/quota-pools/{pool_id}:
patch:
tags:
- Admin - Quotas
summary: Update agency quota pool
description: Update an agency quota pool allocation or expiration.
operationId: update_agency_pool_admin_agencies__agency_id__quota_pools__pool_id__patch
security:
- HTTPBearer: []
parameters:
- name: agency_id
in: path
required: true
schema:
type: string
format: uuid
title: Agency Id
- name: pool_id
in: path
required: true
schema:
type: string
format: uuid
title: Pool Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/api__admin__quotas__UpdateAgencyPoolRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/api__admin__quotas__AgencyPoolResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Admin - Quotas
summary: Delete agency quota pool
description: Delete an agency quota pool. Cannot delete if quota is distributed.
operationId: delete_agency_pool_admin_agencies__agency_id__quota_pools__pool_id__delete
security:
- HTTPBearer: []
parameters:
- name: agency_id
in: path
required: true
schema:
type: string
format: uuid
title: Agency Id
- name: pool_id
in: path
required: true
schema:
type: string
format: uuid
title: Pool Id
- name: force
in: query
required: false
schema:
type: boolean
description: Force delete even if distributed
default: false
title: Force
description: Force delete even if distributed
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/admin/workspaces/{workspace_id}/grant-quota:
post:
tags:
- Admin - Quotas
summary: Grant quota to workspace
description: Admin grants quota directly to a workspace.
operationId: admin_grant_quota_admin_workspaces__workspace_id__grant_quota_post
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AdminGrantQuotaRequest'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AdminGrantQuotaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/admin/quota-dashboard:
get:
tags:
- Admin - Quotas
summary: Get quota dashboard
description: Get system-wide quota statistics and summary.
operationId: get_quota_dashboard_admin_quota_dashboard_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/QuotaDashboardStats'
security:
- HTTPBearer: []
/admin/quota-audit-log:
get:
tags:
- Admin - Quotas
summary: Get quota audit log
description: Get paginated quota audit log with filters.
operationId: get_quota_audit_log_admin_quota_audit_log_get
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Workspace Id
- name: agency_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Agency Id
- name: event_type
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Event Type
- name: page
in: query
required: false
schema:
type: integer
minimum: 1
default: 1
title: Page
- name: page_size
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 50
title: Page Size
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/api__admin__quotas__AuditLogResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
api__admin__quotas__AgencyPoolResponse:
properties:
id:
type: string
title: Id
description: Pool ID
agency_id:
type: string
title: Agency Id
description: Agency ID
agency_name:
anyOf:
- type: string
- type: 'null'
title: Agency Name
description: Agency name
quota_type:
type: string
title: Quota Type
description: Type of quota
resource_id:
anyOf:
- type: string
- type: 'null'
title: Resource Id
description: Resource ID for premium_model
resource_name:
anyOf:
- type: string
- type: 'null'
title: Resource Name
description: Resource name
total_allocation:
type: integer
title: Total Allocation
description: Total amount in pool
distributed:
type: integer
title: Distributed
description: Amount distributed to workspaces
remaining:
type: integer
title: Remaining
description: Available for distribution
expires_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Expires At
description: Expiration timestamp
granted_by:
anyOf:
- type: string
- type: 'null'
title: Granted By
description: Admin who granted
granted_at:
type: string
format: date-time
title: Granted At
description: Grant timestamp
type: object
required:
- id
- agency_id
- quota_type
- total_allocation
- distributed
- remaining
- granted_at
title: AgencyPoolResponse
description: Response schema for an agency quota pool.
api__admin__quotas__UpdateAgencyPoolRequest:
properties:
total_allocation:
anyOf:
- type: integer
exclusiveMinimum: 0.0
- type: 'null'
title: Total Allocation
description: New total allocation
expires_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Expires At
description: New expiration
type: object
title: UpdateAgencyPoolRequest
description: Request schema for updating an agency pool.
QuotaDashboardStats:
properties:
total_workspaces:
type: integer
title: Total Workspaces
description: Total workspaces
total_agencies:
type: integer
title: Total Agencies
description: Total agencies
active_subscriptions:
type: integer
title: Active Subscriptions
description: Active subscriptions count
trial_workspaces:
type: integer
title: Trial Workspaces
description: Workspaces on trial
base_prompts_stats:
additionalProperties: true
type: object
title: Base Prompts Stats
max_prompts_stats:
additionalProperties: true
type: object
title: Max Prompts Stats
premium_model_stats:
additionalProperties: true
type: object
title: Premium Model Stats
visibility_report_stats:
additionalProperties: true
type: object
title: Visibility Report Stats
action_generation_stats:
additionalProperties: true
type: object
title: Action Generation Stats
agency_pools_count:
type: integer
title: Agency Pools Count
default: 0
agency_pools_total_allocated:
type: integer
title: Agency Pools Total Allocated
default: 0
agency_pools_total_distributed:
type: integer
title: Agency Pools Total Distributed
default: 0
recent_events_count:
type: integer
title: Recent Events Count
default: 0
type: object
required:
- total_workspaces
- total_agencies
- active_subscriptions
- trial_workspaces
title: QuotaDashboardStats
description: System-wide quota statistics.
api__admin__quotas__CreateAgencyPoolRequest:
properties:
quota_type:
type: string
title: Quota Type
description: Type of quota
resource_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Resource Id
description: Resource ID for premium_model
total_allocation:
type: integer
exclusiveMinimum: 0.0
title: Total Allocation
description: Total amount to allocate
expires_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Expires At
description: Optional expiration
type: object
required:
- quota_type
- total_allocation
title: CreateAgencyPoolRequest
description: Request schema for creating an agency pool.
CreatePlanQuotaRequest:
properties:
quota_type:
type: string
title: Quota Type
description: Type of quota
resource_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Resource Id
description: Resource ID for premium_model quotas
allocation:
type: integer
minimum: -1.0
title: Allocation
description: Amount to allocate (-1 = unlimited)
reset_period:
type: string
title: Reset Period
description: Reset period (daily, weekly, monthly, never)
default: monthly
type: object
required:
- quota_type
- allocation
title: CreatePlanQuotaRequest
description: Request schema for creating a plan quota.
UpdatePlanQuotaRequest:
properties:
allocation:
anyOf:
- type: integer
minimum: -1.0
- type: 'null'
title: Allocation
description: New allocation amount
reset_period:
anyOf:
- type: string
- type: 'null'
title: Reset Period
description: New reset period
is_active:
anyOf:
- type: boolean
- type: 'null'
title: Is Active
description: Whether quota is active
type: object
title: UpdatePlanQuotaRequest
description: Request schema for updating a plan quota.
AdminGrantQuotaResponse:
properties:
success:
type: boolean
title: Success
description: Whether grant was successful
quota_id:
type: string
title: Quota Id
description: Created quota ID
workspace_id:
type: string
title: Workspace Id
description: Workspace ID
quota_type:
type: string
title: Quota Type
description: Type of quota granted
allocation:
type: integer
title: Allocation
description: Amount granted
message:
type: string
title: Message
description: Result message
type: object
required:
- success
- quota_id
- workspace_id
- quota_type
- allocation
- message
title: AdminGrantQuotaResponse
description: Response schema for admin grant.
AdminGrantQuotaRequest:
properties:
quota_type:
type: string
title: Quota Type
description: Type of quota
resource_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Resource Id
description: Resource ID for premium_model
allocation:
type: integer
exclusiveMinimum: 0.0
title: Allocation
description: Amount to grant
reset_period:
type: string
title: Reset Period
description: Reset period for granted quota
default: never
expires_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Expires At
description: Optional expiration
reason:
type: string
maxLength: 500
minLength: 1
title: Reason
description: Reason for grant
type: object
required:
- quota_type
- allocation
- reason
title: AdminGrantQuotaRequest
description: Request schema for admin granting quota to a workspace.
BulkCreatePlanQuotasRequest:
properties:
quotas:
items:
$ref: '#/components/schemas/CreatePlanQuotaRequest'
type: array
minItems: 1
title: Quotas
type: object
required:
- quotas
title: BulkCreatePlanQuotasRequest
description: Request schema for bulk creating plan quotas.
PlanQuotaResponse:
properties:
id:
type: string
title: Id
description: Plan quota ID
plan_id:
type: string
title: Plan Id
description: Subscription plan ID
plan_name:
anyOf:
- type: string
- type: 'null'
title: Plan Name
description: Plan name
plan_slug:
anyOf:
- type: string
- type: 'null'
title: Plan Slug
description: Plan slug
quota_type:
type: string
title: Quota Type
description: Type of quota
resource_id:
anyOf:
- type: string
- type: 'null'
title: Resource Id
description: Resource ID for premium_model
resource_name:
anyOf:
- type: string
- type: 'null'
title: Resource Name
description: Resource name
allocation:
type: integer
title: Allocation
description: Amount allocated (-1 = unlimited)
reset_period:
type: string
title: Reset Period
description: Reset period
is_active:
type: boolean
title: Is Active
description: Whether quota is active
created_at:
type: string
format: date-time
title: Created At
description: Created timestamp
updated_at:
type: string
format: date-time
title: Updated At
description: Updated timestamp
type: object
required:
- id
- plan_id
- quota_type
- allocation
- reset_period
- is_active
- created_at
- updated_at
title: PlanQuotaResponse
description: Response schema for a plan quota configuration.
api__admin__quotas__AuditLogEntry:
properties:
id:
type: string
title: Id
description: Entry ID
created_at:
type: string
format: date-time
title: Created At
description: Event timestamp
actor_id:
anyOf:
- type: string
- type: 'null'
title: Actor Id
description: Actor ID
actor_type:
type: string
title: Actor Type
description: Actor type
entity_type:
type: string
title: Entity Type
description: Entity type
entity_id:
type: string
title: Entity Id
description: Entity ID
workspace_id:
anyOf:
- type: string
- type: 'null'
title: Workspace Id
description: Workspace ID
agency_id:
anyOf:
- type: string
- type: 'null'
title: Agency Id
description: Agency ID
event_type:
type: string
title: Event Type
description: Event type
details:
additionalProperties: true
type: object
title: Details
description: Event details
type: object
required:
- id
- created_at
- actor_type
- entity_type
- entity_id
- event_type
title: AuditLogEntry
description: Single audit log entry.
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
api__admin__quotas__AuditLogResponse:
properties:
entries:
items:
$ref: '#/components/schemas/api__admin__quotas__AuditLogEntry'
type: array
title: Entries
total_count:
type: integer
title: Total Count
default: 0
page:
type: integer
title: Page
default: 1
page_size:
type: integer
title: Page Size
default: 50
type: object
title: AuditLogResponse
description: Paginated audit log 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