NudgeLink Dashboard API

The dashboard API from NudgeLink — 3 operation(s) for dashboard.

GitHub OpenAPI

Operations 3

GET /api/v1/dashboard/kpi Kpi #
GET /api/v1/dashboard/stats/monthly Stats Monthly #
GET /api/v1/dashboard/activity Activity #

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/nudgelink-co:nudgelink-co-dashboard-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

nudgelink-co-dashboard-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NudgeLink Dashboard API
  version: 0.1.0
tags:
- name: Dashboard
paths:
  /api/v1/dashboard/kpi:
    get:
      tags:
      - Dashboard
      summary: Kpi
      operationId: kpi_api_v1_dashboard_kpi_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardKPI'
      security:
      - HTTPBearer: []
  /api/v1/dashboard/stats/monthly:
    get:
      tags:
      - Dashboard
      summary: Stats Monthly
      description: 'Per-month invite/accept breakdown for the current client. Scoped to the

        caller — same client-scoping as ``/kpi`` — so it never leaks another

        client''s numbers.'
      operationId: stats_monthly_api_v1_dashboard_stats_monthly_get
      security:
      - HTTPBearer: []
      parameters:
      - name: months
        in: query
        required: false
        schema:
          type: integer
          maximum: 24
          minimum: 1
          default: 6
          title: Months
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonthlyStatsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/dashboard/activity:
    get:
      tags:
      - Dashboard
      summary: Activity
      description: 'Real, merged, time-descending activity feed for the overview page.


        Sources (each capped at ``limit`` before the merge so no single stream can

        starve the others): outbound sends, inbound replies, finished discovery

        runs, and account lifecycle events (connected / paused-by-system /

        requires-action). The union is re-sorted by timestamp and sliced to

        ``limit``. Replaces the old static/fake Activity panel.'
      operationId: activity_api_v1_dashboard_activity_get
      security:
      - HTTPBearer: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 50
          minimum: 1
          default: 20
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActivityItem'
                title: Response Activity Api V1 Dashboard Activity Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DashboardKPI:
      properties:
        leads_total:
          type: integer
          title: Leads Total
        leads_in_outreach:
          type: integer
          title: Leads In Outreach
        leads_replied:
          type: integer
          title: Leads Replied
        accounts_active:
          type: integer
          title: Accounts Active
        accounts_warming:
          type: integer
          title: Accounts Warming
        sequences_active:
          type: integer
          title: Sequences Active
        sequences_paused:
          type: integer
          title: Sequences Paused
        messages_pending_preview:
          type: integer
          title: Messages Pending Preview
        qualified_replies_this_month:
          type: integer
          title: Qualified Replies This Month
        accept_rate_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Accept Rate Pct
        avg_relevance_score:
          anyOf:
          - type: integer
          - type: 'null'
          title: Avg Relevance Score
        est_pipeline_usd:
          type: number
          title: Est Pipeline Usd
        invites_sent_today:
          type: integer
          title: Invites Sent Today
        invites_cap_today:
          type: integer
          title: Invites Cap Today
        messages_sent_7d:
          type: integer
          title: Messages Sent 7D
        replies_7d:
          type: integer
          title: Replies 7D
        sends_by_day:
          items:
            $ref: '#/components/schemas/SendsByDay'
          type: array
          title: Sends By Day
        stats:
          $ref: '#/components/schemas/OutreachStats'
      type: object
      required:
      - leads_total
      - leads_in_outreach
      - leads_replied
      - accounts_active
      - accounts_warming
      - sequences_active
      - sequences_paused
      - messages_pending_preview
      - qualified_replies_this_month
      - accept_rate_pct
      - avg_relevance_score
      - est_pipeline_usd
      - invites_sent_today
      - invites_cap_today
      - messages_sent_7d
      - replies_7d
      - sends_by_day
      - stats
      title: DashboardKPI
    MonthlyStatsResponse:
      properties:
        months:
          items:
            $ref: '#/components/schemas/MonthlyStats'
          type: array
          title: Months
      type: object
      required:
      - months
      title: MonthlyStatsResponse
    OutreachStats:
      properties:
        invites:
          $ref: '#/components/schemas/InviteStats'
        replies:
          $ref: '#/components/schemas/ReplyStats'
        comments_sent:
          type: integer
          title: Comments Sent
          default: 0
      type: object
      title: OutreachStats
    SendsByDay:
      properties:
        date:
          type: string
          title: Date
        sent:
          type: integer
          title: Sent
        replies:
          type: integer
          title: Replies
      type: object
      required:
      - date
      - sent
      - replies
      title: SendsByDay
    InviteStats:
      properties:
        sent:
          type: integer
          title: Sent
          default: 0
        with_note:
          type: integer
          title: With Note
          default: 0
        without_note:
          type: integer
          title: Without Note
          default: 0
        accepted:
          type: integer
          title: Accepted
          default: 0
        accepted_with_note:
          type: integer
          title: Accepted With Note
          default: 0
        accepted_without_note:
          type: integer
          title: Accepted Without Note
          default: 0
        declined:
          type: integer
          title: Declined
          default: 0
        unknown:
          type: integer
          title: Unknown
          default: 0
        judged:
          type: integer
          title: Judged
          default: 0
        judged_with_note:
          type: integer
          title: Judged With Note
          default: 0
        judged_without_note:
          type: integer
          title: Judged Without Note
          default: 0
        accept_rate_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Accept Rate Pct
        accept_rate_with_note_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Accept Rate With Note Pct
        accept_rate_without_note_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Accept Rate Without Note Pct
      type: object
      title: InviteStats
      description: "Connection requests. ``*_pct`` are None (never 0.0) on an empty base.\n\nTHREE outcomes, not two (added 2026-08-07 after the first production\nbackfill). An invite we sent is in exactly one of:\n\n  * **accepted**  — ``invite_accepted_at`` is stamped.\n  * **declined**  — we looked AFTER inviting and they are still not a\n    connection. \"Declined\" is shorthand: it also covers ignored.\n  * **unknown**   — we have no observation since the invite went out.\n\nThat third bucket is not a technicality. Relationship distance is only\nrefreshed by the DM gate, which runs when a sequence reaches\n``linkedin_followup_1``; ``warmup_view``'s blob is written BEFORE the invite\nand carries no timestamp at all. So a lead whose follow-up is still sitting\nin the preview queue has never been re-checked, and folding those into the\ndenominator reports them as rejections.\n\nThe first prod run showed exactly that: 379 invites, 376 \"not 1st-degree\",\nan 0.8% accept rate. Real cold-invite accept rates are 15-40%. Nearly all of\nthat 376 was \"we never looked\", and dividing by it would have put a\ncatastrophic-looking number in front of clients.\n\nSo ``accept_rate_pct`` divides by **accepted + declined** — what we actually\nknow — and ``unknown`` is reported alongside so the number can be read with\nits own confidence attached. The bucket shrinks toward zero once PR 2's\n``relation.new`` webhook lands, which is the real fix."
    ActivityItem:
      properties:
        type:
          type: string
          title: Type
        text_key:
          type: string
          title: Text Key
        params:
          additionalProperties:
            anyOf:
            - type: string
            - type: integer
          type: object
          title: Params
        ts:
          type: string
          format: date-time
          title: Ts
        href:
          type: string
          title: Href
      type: object
      required:
      - type
      - text_key
      - params
      - ts
      - href
      title: ActivityItem
      description: 'One row in the merged, time-desc activity feed.


        ``text_key`` is an i18n key the frontend resolves against

        ``dashboard.activity.*`` (with ``params`` interpolated) — the backend never

        emits user-facing English (QA 2026-06-09 BUG-8). ``type`` drives the row''s

        colour dot; ``href`` is the relative page the row links to.'
    MonthlyStats:
      properties:
        month:
          type: string
          title: Month
        invites:
          $ref: '#/components/schemas/InviteStats'
      type: object
      required:
      - month
      title: MonthlyStats
      description: 'One calendar month of the invite block (2026-08-20, Sofia: "чтобы инфа

        отдельно распределялась, по месяцам").


        Invites ONLY — not replies. Invites are windowed by ``Message.sent_at``,

        which has a clean month; a reply has no ``sent_at`` (it is keyed off inbound

        ``created_at``), so a per-month reply rate would divide a ``sent_at``-windowed

        denominator by a ``created_at``-windowed numerator — two different ranges.

        The accept rate is the number the monthly view exists to show, so it carries

        the whole :class:`InviteStats` and leaves replies to the all-time block.'
    ReplyStats:
      properties:
        dms_sent:
          type: integer
          title: Dms Sent
          default: 0
        emails_sent:
          type: integer
          title: Emails Sent
          default: 0
        contacted:
          type: integer
          title: Contacted
          default: 0
        replied:
          type: integer
          title: Replied
          default: 0
        reply_rate_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Reply Rate Pct
        positive:
          type: integer
          title: Positive
          default: 0
        neutral:
          type: integer
          title: Neutral
          default: 0
        negative:
          type: integer
          title: Negative
          default: 0
        unclassified:
          type: integer
          title: Unclassified
          default: 0
        silent:
          type: integer
          title: Silent
          default: 0
      type: object
      title: ReplyStats
      description: 'Messages sent and what came back.


        ``contacted`` counts SEQUENCES (people) reached by any substantive step, not

        messages — an invite plus two follow-ups to one lead is one person.

        ``silent`` is the complement, so

        positive + neutral + negative + unclassified + silent == contacted.'
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer