GroundRoute AI

GroundRoute AI Admin API

The admin API from GroundRoute AI — 14 operation(s) for admin.

GitHub OpenAPI

Operations 14

POST /admin/login Login #
POST /admin/logout Logout #
GET /admin/me Me #
GET /admin/fleet Fleet #
GET /admin/economics Economics View #
GET /admin/tenants Tenants #
GET /admin/tenants/{tenant_id} Tenant Drilldown #
GET /admin/searches/daily Searches Daily View #
GET /admin/funnel Funnel View #
POST /admin/tenants/{tenant_id}/delete-account Delete Account #
GET /admin/engines Engines View #
GET /admin/cache Cache View #
GET /admin/health Health View #
GET /admin/audit Audit Log View #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/groundroute-ai/openapi/groundroute-ai-admin-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-shim-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-workspace-settings-update-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-workspace-settings-view-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-tenant-drill-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-overview-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-tenant-row-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/groundroute-ai/apis.yml

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/groundroute-ai:groundroute-ai-admin-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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

groundroute-ai-admin-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GroundRoute Admin API
  version: 0.3.0
tags:
- name: Admin
paths:
  /admin/login:
    post:
      tags:
      - Admin
      summary: Login
      description: Password + mandatory TOTP. Sets the admin session cookie. Not behind require_admin.
      operationId: login_admin_login_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminLoginRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminMe'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/logout:
    post:
      tags:
      - Admin
      summary: Logout
      operationId: logout_admin_logout_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
                title: Response Logout Admin Logout Post
  /admin/me:
    get:
      tags:
      - Admin
      summary: Me
      operationId: me_admin_me_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminMe'
  /admin/fleet:
    get:
      tags:
      - Admin
      summary: Fleet
      operationId: fleet_admin_fleet_get
      parameters:
      - name: window
        in: query
        required: false
        schema:
          type: string
          default: 30d
          title: Window
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FleetOverview'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/economics:
    get:
      tags:
      - Admin
      summary: Economics View
      operationId: economics_view_admin_economics_get
      parameters:
      - name: window
        in: query
        required: false
        schema:
          type: string
          default: 30d
          title: Window
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EconomicsRollup'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/tenants:
    get:
      tags:
      - Admin
      summary: Tenants
      operationId: tenants_admin_tenants_get
      parameters:
      - name: window
        in: query
        required: false
        schema:
          type: string
          default: 30d
          title: Window
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          default: 100
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TenantRow'
                title: Response Tenants Admin Tenants Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/tenants/{tenant_id}:
    get:
      tags:
      - Admin
      summary: Tenant Drilldown
      operationId: tenant_drilldown_admin_tenants__tenant_id__get
      parameters:
      - name: tenant_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Tenant Id
      - name: window
        in: query
        required: false
        schema:
          type: string
          default: 30d
          title: Window
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantDrill'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/searches/daily:
    get:
      tags:
      - Admin
      summary: Searches Daily View
      description: 'Per-engine searches/day across the platform (operator total) — the fleet chart for #5.'
      operationId: searches_daily_view_admin_searches_daily_get
      parameters:
      - name: window
        in: query
        required: false
        schema:
          type: string
          default: 30d
          title: Window
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchesDaily'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/funnel:
    get:
      tags:
      - Admin
      summary: Funnel View
      description: Platform conversion funnel by month (landing → started → completed → activated → paying).
      operationId: funnel_view_admin_funnel_get
      parameters:
      - name: months
        in: query
        required: false
        schema:
          type: integer
          maximum: 36
          minimum: 1
          default: 12
          title: Months
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FunnelReport'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/tenants/{tenant_id}/delete-account:
    post:
      tags:
      - Admin
      summary: Delete Account
      description: 'HARD-delete a tenant and every row scoped to it. Irreversible. Guards, in order:

        require_admin → fresh MFA re-verify (second factor on the destructive act) → typed-name

        confirmation → audit row → cascade, audit+delete in ONE writable tx (all-or-nothing). This is

        the only admin endpoint that mutates; the rest stay read-only (A-6). Cascade is idempotent

        (WHERE tenant_id) but the resource itself 404s once gone.'
      operationId: delete_account_admin_tenants__tenant_id__delete_account_post
      parameters:
      - name: tenant_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Tenant Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAccountRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAccountResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/engines:
    get:
      tags:
      - Admin
      summary: Engines View
      operationId: engines_view_admin_engines_get
      parameters:
      - name: window
        in: query
        required: false
        schema:
          type: string
          default: 30d
          title: Window
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EngineRow'
                title: Response Engines View Admin Engines Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/cache:
    get:
      tags:
      - Admin
      summary: Cache View
      operationId: cache_view_admin_cache_get
      parameters:
      - name: window
        in: query
        required: false
        schema:
          type: string
          default: 30d
          title: Window
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CacheMoat'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/health:
    get:
      tags:
      - Admin
      summary: Health View
      operationId: health_view_admin_health_get
      parameters:
      - name: window
        in: query
        required: false
        schema:
          type: string
          default: 30d
          title: Window
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthAbuse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/audit:
    get:
      tags:
      - Admin
      summary: Audit Log View
      operationId: audit_log_view_admin_audit_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          default: 100
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AdminAuditEntry'
                title: Response Audit Log View Admin Audit Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TenantDrill:
      properties:
        tenant_id:
          type: string
          title: Tenant Id
        company_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Company Name
        signed_up_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Signed Up At
        tier:
          type: string
          title: Tier
        window:
          type: string
          title: Window
        prepaid_credit_usd:
          type: number
          title: Prepaid Credit Usd
        searches:
          type: integer
          title: Searches
        provider_cost_usd:
          type: number
          title: Provider Cost Usd
        est_revenue_usd:
          type: number
          title: Est Revenue Usd
        cache_mix:
          additionalProperties:
            type: integer
          type: object
          title: Cache Mix
        engine_mix:
          additionalProperties:
            type: integer
          type: object
          title: Engine Mix
        error_rate:
          type: number
          title: Error Rate
        p95_latency_ms:
          anyOf:
          - type: number
          - type: 'null'
          title: P95 Latency Ms
        users:
          items:
            $ref: '#/components/schemas/AdminUserRow'
          type: array
          title: Users
      additionalProperties: false
      type: object
      required:
      - tenant_id
      - company_name
      - signed_up_at
      - tier
      - window
      - prepaid_credit_usd
      - searches
      - provider_cost_usd
      - est_revenue_usd
      - cache_mix
      - engine_mix
      - error_rate
      - p95_latency_ms
      - users
      title: TenantDrill
    EngineRow:
      properties:
        engine:
          type: string
          title: Engine
        searches:
          type: integer
          title: Searches
        provider_cost_usd:
          type: number
          title: Provider Cost Usd
        cost_per_1k_usd:
          type: number
          title: Cost Per 1K Usd
        p50_latency_ms:
          anyOf:
          - type: number
          - type: 'null'
          title: P50 Latency Ms
        p95_latency_ms:
          anyOf:
          - type: number
          - type: 'null'
          title: P95 Latency Ms
        suppressed:
          type: boolean
          title: Suppressed
      additionalProperties: false
      type: object
      required:
      - engine
      - searches
      - provider_cost_usd
      - cost_per_1k_usd
      - p50_latency_ms
      - p95_latency_ms
      - suppressed
      title: EngineRow
    DeleteAccountResponse:
      properties:
        status:
          type: string
          title: Status
        tenant_id:
          type: string
          title: Tenant Id
        deleted_counts:
          additionalProperties:
            type: integer
          type: object
          title: Deleted Counts
      additionalProperties: false
      type: object
      required:
      - status
      - tenant_id
      - deleted_counts
      title: DeleteAccountResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    AdminUserRow:
      properties:
        email:
          type: string
          title: Email
        created_at:
          type: string
          format: date-time
          title: Created At
      additionalProperties: false
      type: object
      required:
      - email
      - created_at
      title: AdminUserRow
    AdminAuditEntry:
      properties:
        ts:
          type: string
          format: date-time
          title: Ts
        admin_id:
          type: string
          title: Admin Id
        action:
          type: string
          title: Action
        tenant_scope:
          anyOf:
          - type: string
          - type: 'null'
          title: Tenant Scope
        ip:
          type: string
          title: Ip
        detail:
          additionalProperties: true
          type: object
          title: Detail
      additionalProperties: false
      type: object
      required:
      - ts
      - admin_id
      - action
      - tenant_scope
      - ip
      - detail
      title: AdminAuditEntry
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CacheMoat:
      properties:
        window:
          type: string
          title: Window
        pooled_hit_rate:
          anyOf:
          - type: number
          - type: 'null'
          title: Pooled Hit Rate
        private_hit_rate:
          type: number
          title: Private Hit Rate
        pooled_minus_private_pts:
          anyOf:
          - type: number
          - type: 'null'
          title: Pooled Minus Private Pts
        distinct_tenants:
          type: integer
          title: Distinct Tenants
        k_suppressed:
          type: boolean
          title: K Suppressed
      additionalProperties: false
      type: object
      required:
      - window
      - pooled_hit_rate
      - private_hit_rate
      - pooled_minus_private_pts
      - distinct_tenants
      - k_suppressed
      title: CacheMoat
    FunnelPeriod:
      properties:
        period:
          type: string
          title: Period
        stages:
          items:
            $ref: '#/components/schemas/FunnelStage'
          type: array
          title: Stages
      additionalProperties: false
      type: object
      required:
      - period
      - stages
      title: FunnelPeriod
    FleetOverview:
      properties:
        window:
          type: string
          title: Window
        total_searches:
          type: integer
          title: Total Searches
        active_tenants:
          type: integer
          title: Active Tenants
        est_revenue_usd:
          type: number
          title: Est Revenue Usd
        provider_cost_usd:
          type: number
          title: Provider Cost Usd
        blended_margin_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Blended Margin Pct
        managed_searches:
          type: integer
          title: Managed Searches
        byok_searches:
          type: integer
          title: Byok Searches
        pooled_cache_hit_rate:
          anyOf:
          - type: number
          - type: 'null'
          title: Pooled Cache Hit Rate
      additionalProperties: false
      type: object
      required:
      - window
      - total_searches
      - active_tenants
      - est_revenue_usd
      - provider_cost_usd
      - blended_margin_pct
      - managed_searches
      - byok_searches
      - pooled_cache_hit_rate
      title: FleetOverview
    FunnelReport:
      properties:
        bucket:
          type: string
          title: Bucket
        periods:
          items:
            $ref: '#/components/schemas/FunnelPeriod'
          type: array
          title: Periods
      additionalProperties: false
      type: object
      required:
      - bucket
      - periods
      title: FunnelReport
    EconomicsRollup:
      properties:
        window:
          type: string
          title: Window
        est_revenue_usd:
          type: number
          title: Est Revenue Usd
        provider_cost_usd:
          type: number
          title: Provider Cost Usd
        gross_margin_usd:
          type: number
          title: Gross Margin Usd
        blended_margin_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Blended Margin Pct
        cost_per_1k_usd:
          type: number
          title: Cost Per 1K Usd
        managed_revenue_usd:
          type: number
          title: Managed Revenue Usd
        byok_revenue_usd:
          type: number
          title: Byok Revenue Usd
        managed_searches:
          type: integer
          title: Managed Searches
        byok_searches:
          type: integer
          title: Byok Searches
      additionalProperties: false
      type: object
      required:
      - window
      - est_revenue_usd
      - provider_cost_usd
      - gross_margin_usd
      - blended_margin_pct
      - cost_per_1k_usd
      - managed_revenue_usd
      - byok_revenue_usd
      - managed_searches
      - byok_searches
      title: EconomicsRollup
    DeleteAccountRequest:
      properties:
        confirm_name:
          type: string
          title: Confirm Name
        totp_code:
          type: string
          title: Totp Code
          default: ''
      additionalProperties: false
      type: object
      required:
      - confirm_name
      title: DeleteAccountRequest
    AdminLoginRequest:
      properties:
        email:
          type: string
          title: Email
        password:
          type: string
          title: Password
        totp_code:
          type: string
          title: Totp Code
          default: ''
      additionalProperties: false
      type: object
      required:
      - email
      - password
      title: AdminLoginRequest
    AdminMe:
      properties:
        email:
          type: string
          title: Email
        role:
          type: string
          title: Role
      additionalProperties: false
      type: object
      required:
      - email
      - role
      title: AdminMe
    FunnelStage:
      properties:
        stage:
          type: string
          title: Stage
        count:
          type: integer
          title: Count
        conversion_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Conversion Pct
        drop_off_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Drop Off Pct
      additionalProperties: false
      type: object
      required:
      - stage
      - count
      - conversion_pct
      - drop_off_pct
      title: FunnelStage
    SearchesDaily:
      properties:
        days:
          items:
            $ref: '#/components/schemas/DailyEngineCounts'
          type: array
          title: Days
      additionalProperties: false
      type: object
      required:
      - days
      title: SearchesDaily
    DailyEngineCounts:
      properties:
        date:
          type: string
          title: Date
        by_engine:
          additionalProperties:
            type: integer
          type: object
          title: By Engine
      additionalProperties: false
      type: object
      required:
      - date
      - by_engine
      title: DailyEngineCounts
    HealthAbuse:
      properties:
        window:
          type: string
          title: Window
        error_rate:
          type: number
          title: Error Rate
        error_events:
          type: integer
          title: Error Events
        spend_cap_breaches:
          type: integer
          title: Spend Cap Breaches
        rate_limit_events:
          type: integer
          title: Rate Limit Events
        byok_anomaly_tenants:
          type: integer
          title: Byok Anomaly Tenants
      additionalProperties: false
      type: object
      required:
      - window
      - error_rate
      - error_events
      - spend_cap_breaches
      - rate_limit_events
      - byok_anomaly_tenants
      title: HealthAbuse
    TenantRow:
      properties:
        tenant_id:
          type: string
          title: Tenant Id
        company_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Company Name
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
        signed_up_at:
          type: string
          format: date-time
          title: Signed Up At
        tier:
          type: string
          title: Tier
        status:
          type: string
          title: Status
        prepaid_credit_usd:
          type: number
          title: Prepaid Credit Usd
        searches:
          type: integer
          title: Searches
        provider_cost_usd:
          type: number
          title: Provider Cost Usd
        est_revenue_usd:
          type: number
          title: Est Revenue Usd
        est_margin_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Est Margin Pct
        cache_hit_rate:
          type: number
          title: Cache Hit Rate
        error_rate:
          type: number
          title: Error Rate
        health:
          type: string
          title: Health
      additionalProperties: false
      type: object
      required:
      - tenant_id
      - company_name
      - email
      - signed_up_at
      - tier
      - status
      - prepaid_credit_usd
      - searches
      - provider_cost_usd
      - est_revenue_usd
      - est_margin_pct
      - cache_hit_rate
      - error_rate
      - health
      title: TenantRow