Dregs

Dregs Dashboard API

Dashboard summary data

GitHub OpenAPI

Operations 6

GET /api/dashboard/timeseries Dashboard timeseries #
GET /api/dashboard/stats Dashboard stats #
GET /api/dashboard/score-distribution Score distribution #
GET /api/dashboard/rule-activity Rule activity #
GET /api/dashboard/recently-active Recently active identities #
GET /api/dashboard/attention Attention summary #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/dregs-com/openapi/dregs-com-dashboard-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/dregs-com/json-schema/dregs-com-v1-escalation-schema.json
📊
JSONSchema
https://artifacts.apis.io/dregs-com/json-schema/dregs-com-v1-tracked-event-schema.json
📊
JSONSchema
https://artifacts.apis.io/dregs-com/json-schema/dregs-com-v1-track-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/dregs-com/json-schema/dregs-com-v1-page-v1-dataset-entry-schema.json
📊
JSONSchema
https://artifacts.apis.io/dregs-com/json-schema/dregs-com-v1-page-v1-tracked-event-schema.json
📊
JSONSchema
https://artifacts.apis.io/dregs-com/json-schema/dregs-com-v1-page-v1-escalation-schema.json

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/dregs-com:dregs-com-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. 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

dregs-com-dashboard-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Dregs Dashboard API
  description: 'Customer REST API for sending events and reading fraud scores, identities, devices, escalations, channels, datasets, and mappings.


    Authenticate with a secret key created in the dashboard under Settings > Credentials (security scheme secretKey). Send it as a Bearer token: Authorization: Bearer sk_... The key acts as an admin of that credential''s team. POST /api/events and GET /api/devices/{fingerprint} also accept the credential''s public key (security scheme publicKey, Bearer pk_...). Public keys may be embedded in a browser. Secret keys must not.


    This document is the curated public surface. Dashboard sign-in, billing, team administration, and trainer tools are not included.'
  version: '1.0'
servers:
- url: https://dregs.com
  description: Dregs API
security:
- secretKey: []
tags:
- name: Dashboard
  description: Dashboard summary data
paths:
  /api/dashboard/timeseries:
    get:
      tags:
      - Dashboard
      summary: Dashboard timeseries
      description: Get hourly or daily buckets for events, active identities, and scored identities over the chosen range (24h/7d/30d)
      operationId: getDashboardTimeseries
      parameters:
      - name: range
        in: query
        required: false
        schema:
          type: string
          default: 7d
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1DashboardTimeseries'
      security:
      - secretKey: []
  /api/dashboard/stats:
    get:
      tags:
      - Dashboard
      summary: Dashboard stats
      description: Get summary statistics for the dashboard
      operationId: getDashboardStats
      parameters:
      - name: from
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: to
        in: query
        required: false
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1DashboardStats'
      security:
      - secretKey: []
  /api/dashboard/score-distribution:
    get:
      tags:
      - Dashboard
      summary: Score distribution
      description: Get score distribution across buckets for all four categories
      operationId: getScoreDistribution
      parameters:
      - name: from
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: to
        in: query
        required: false
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1ScoreDistribution'
      security:
      - secretKey: []
  /api/dashboard/rule-activity:
    get:
      tags:
      - Dashboard
      summary: Rule activity
      description: Get per-badge-rule identity groups and per-escalation-rule escalation groups with activity within the selected range
      operationId: getRuleActivity
      parameters:
      - name: from
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: to
        in: query
        required: false
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1RuleActivity'
      security:
      - secretKey: []
  /api/dashboard/recently-active:
    get:
      tags:
      - Dashboard
      summary: Recently active identities
      description: Get the 5 most recently active identities
      operationId: getRecentlyActive
      parameters:
      - name: from
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: to
        in: query
        required: false
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/V1Identity'
      security:
      - secretKey: []
  /api/dashboard/attention:
    get:
      tags:
      - Dashboard
      summary: Attention summary
      description: Get counts of items needing attention (open escalations by severity, high-risk identities in last 24h, failed channel deliveries in last 24h)
      operationId: getAttention
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1AttentionSummary'
      security:
      - secretKey: []
components:
  schemas:
    V1Identity:
      type: object
      properties:
        id:
          type: string
        displayName:
          type: string
        displayEmail:
          type: string
        displayUsername:
          type: string
        humanityScore:
          type: integer
          format: int32
        authenticityScore:
          type: integer
          format: int32
        uniquenessScore:
          type: integer
          format: int32
        behaviorScore:
          type: integer
          format: int32
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        lastTrackedAt:
          type: string
          format: date-time
        lastScoredAt:
          type: string
          format: date-time
        disregarded:
          type: boolean
        badges:
          type: array
          items:
            $ref: '#/components/schemas/V1Badge'
        data:
          type: object
          additionalProperties: {}
    V1BadgeActivityGroup:
      type: object
      properties:
        rule:
          $ref: '#/components/schemas/V1BadgeRule'
        identities:
          type: array
          items:
            $ref: '#/components/schemas/V1Identity'
        totalIdentities:
          type: integer
          format: int64
    V1DashboardStats:
      type: object
      properties:
        totalIdentities:
          type: integer
          format: int64
        totalScored:
          type: integer
          format: int64
        totalEvents:
          type: integer
          format: int64
        identitiesActiveInRange:
          type: integer
          format: int64
        identitiesScoredInRange:
          type: integer
          format: int64
        eventsInRange:
          type: integer
          format: int64
    V1TimeseriesPoint:
      type: object
      properties:
        bucket:
          type: string
        value:
          type: integer
          format: int64
    V1BadgeRule:
      type: object
      properties:
        id:
          type: integer
          format: int64
        slug:
          type: string
        name:
          type: string
        type:
          type: string
          enum:
          - GOOD
          - BAD
          - NEUTRAL
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/RuleCondition'
        priority:
          type: integer
          format: int32
        applyDelaySeconds:
          type: integer
          format: int32
        removeDelaySeconds:
          type: integer
          format: int32
        enabled:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    V1AttentionSummary:
      type: object
      properties:
        openEscalationsCritical:
          type: integer
          format: int64
        openEscalationsWarning:
          type: integer
          format: int64
        openEscalationsInfo:
          type: integer
          format: int64
        failedDeliveries24h:
          type: integer
          format: int64
    BadgeSnapshot:
      type: object
      properties:
        slug:
          type: string
        name:
          type: string
        type:
          type: string
          enum:
          - GOOD
          - BAD
          - NEUTRAL
        explanation:
          type: string
    ScoreSnapshot:
      type: object
      properties:
        humanity:
          type: integer
          format: int32
        authenticity:
          type: integer
          format: int32
        uniqueness:
          type: integer
          format: int32
        behavior:
          type: integer
          format: int32
    V1DashboardTimeseries:
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/V1TimeseriesPoint'
        identitiesActive:
          type: array
          items:
            $ref: '#/components/schemas/V1TimeseriesPoint'
        identitiesScored:
          type: array
          items:
            $ref: '#/components/schemas/V1TimeseriesPoint'
        totalIdentities:
          type: array
          items:
            $ref: '#/components/schemas/V1TimeseriesPoint'
    V1ScoreDistribution:
      type: object
      properties:
        humanity:
          type: object
          additionalProperties:
            type: integer
            format: int64
        authenticity:
          type: object
          additionalProperties:
            type: integer
            format: int64
        uniqueness:
          type: object
          additionalProperties:
            type: integer
            format: int64
        behavior:
          type: object
          additionalProperties:
            type: integer
            format: int64
    V1Reference:
      type: object
      description: Reference to another entity with ID, label, and API path
      properties:
        id:
          type: string
          description: Unique identifier for the entity
          example: abc123
        label:
          type: string
          description: Human-readable label or name
          example: Bob User
        path:
          type: string
          description: API path to the entity resource
          example: /api/identities/abc123
    RuleCondition:
      type: object
      properties:
        condition:
          type: string
        category:
          type: string
        threshold:
          type: integer
          format: int32
        badge:
          type: string
        seconds:
          type: integer
          format: int32
    V1EscalationActivityGroup:
      type: object
      properties:
        rule:
          $ref: '#/components/schemas/V1EscalationRule'
        escalations:
          type: array
          items:
            $ref: '#/components/schemas/V1Escalation'
        totalEscalations:
          type: integer
          format: int64
    V1Escalation:
      type: object
      properties:
        id:
          type: integer
          format: int64
        escalationRule:
          $ref: '#/components/schemas/V1Reference'
        identity:
          $ref: '#/components/schemas/V1Reference'
        identityName:
          type: string
        identityEmail:
          type: string
        identityUsername:
          type: string
        scoreSnapshot:
          $ref: '#/components/schemas/ScoreSnapshot'
        badgeSnapshot:
          type: array
          items:
            $ref: '#/components/schemas/BadgeSnapshot'
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/RuleCondition'
        triggeredConditions:
          type: array
          items:
            type: boolean
        severity:
          type: string
          enum:
          - INFO
          - WARNING
          - CRITICAL
        status:
          type: string
          enum:
          - PENDING
          - OPEN
          - ACKNOWLEDGED
          - CLOSED
        openedAt:
          type: string
          format: date-time
        acknowledgedBy:
          type: integer
          format: int64
        acknowledgedAt:
          type: string
          format: date-time
        closedBy:
          type: integer
          format: int64
        closedAt:
          type: string
          format: date-time
        channels:
          type: array
          items:
            type: string
        ruleDeleted:
          type: boolean
        createdAt:
          type: string
          format: date-time
    V1RuleActivity:
      type: object
      properties:
        badges:
          type: array
          items:
            $ref: '#/components/schemas/V1BadgeActivityGroup'
        escalations:
          type: array
          items:
            $ref: '#/components/schemas/V1EscalationActivityGroup'
    V1Badge:
      type: object
      properties:
        slug:
          type: string
        name:
          type: string
        type:
          type: string
          enum:
          - GOOD
          - BAD
          - NEUTRAL
        explanation:
          type: string
        metadata:
          type: object
          additionalProperties: {}
    V1EscalationRule:
      type: object
      properties:
        id:
          type: integer
          format: int64
        slug:
          type: string
        name:
          type: string
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/RuleCondition'
        severity:
          type: string
          enum:
          - INFO
          - WARNING
          - CRITICAL
        channels:
          type: array
          items:
            type: string
        openAfterSeconds:
          type: integer
          format: int32
        closeAfterSeconds:
          type: integer
          format: int32
        effectiveAt:
          type: string
          format: date-time
        enabled:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  securitySchemes:
    secretKey:
      type: http
      description: Customer secret key from Settings > Credentials, sent as a Bearer token. The token value starts with sk_. It acts as an admin of that credential's team for every operation in this document. MCP tokens (dmcp_) are refused. Prefer the publicKey scheme on operations that accept a pk_ key.
      scheme: bearer
      bearerFormat: sk_
    publicKey:
      type: http
      description: Customer public key from Settings > Credentials, sent as a Bearer token. The token value starts with pk_. Accepted only by POST /api/events and GET /api/devices/{fingerprint}. It may be embedded in a browser. It cannot call the other operations in this document.
      scheme: bearer
      bearerFormat: pk_