Dregs Datasets API

openapi: 3.2.0
info:
  title: Dregs Datasets 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: Datasets
  description: Dataset management for analyzers
paths:
  /api/datasets/{slug}/entries:
    get:
      tags:
      - Datasets
      summary: List entries for a dataset
      description: List entries in a dataset. Results are paginated with pageNumber and pageSize.
      operationId: listDatasetEntries
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      - name: scope
        in: query
        required: true
        schema:
          type: string
          enum:
          - global
          - customer
      - name: pageNumber
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: pageSize
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 200
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1PageV1DatasetEntry'
      security:
      - secretKey: []
    post:
      tags:
      - Datasets
      summary: Add entry to dataset
      description: Add or replace one entry in a dataset. Requires the admin role.
      operationId: addDatasetEntry
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      - name: scope
        in: query
        required: true
        schema:
          type: string
          enum:
          - global
          - customer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1DatasetEntryInput'
        required: true
      responses:
        '200':
          description: Entry saved
        '400':
          description: Invalid entry
        '401':
          description: Authentication required
      security:
      - secretKey: []
    delete:
      tags:
      - Datasets
      summary: Remove entry from dataset
      description: Remove one entry from a dataset by key. Requires the admin role.
      operationId: removeDatasetEntry
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      - name: scope
        in: query
        required: true
        schema:
          type: string
          enum:
          - global
          - customer
      - name: key
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Entry removed
        '401':
          description: Authentication required
        '404':
          description: Entry not found
      security:
      - secretKey: []
  /api/datasets:
    get:
      tags:
      - Datasets
      summary: List datasets with entry counts
      description: List datasets at the requested scope, with entry counts. Customer scope is the team's datasets. Global scope is the shared catalogs.
      operationId: listDatasets
      parameters:
      - name: scope
        in: query
        required: true
        schema:
          type: string
          enum:
          - global
          - customer
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/V1DatasetOverview'
      security:
      - secretKey: []
components:
  schemas:
    V1DatasetEntry:
      type: object
      properties:
        id:
          type: integer
          format: int64
        key:
          type: string
        value:
          type: string
    V1DatasetOverview:
      type: object
      properties:
        slug:
          type: string
        name:
          type: string
        description:
          type: string
        caseSensitive:
          type: boolean
        type:
          type: string
        trainerOnly:
          type: boolean
        customerEntryCount:
          type: integer
          format: int64
        globalEntryCount:
          type: integer
          format: int64
    V1DatasetEntryInput:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
    V1PageV1DatasetEntry:
      type: object
      description: Paginated response wrapper
      properties:
        pageNumber:
          type: integer
          format: int32
          description: Current page number (0-based)
        pageSize:
          type: integer
          format: int32
          description: Number of items per page
        totalPages:
          type: integer
          format: int64
          description: Total number of pages
        totalElements:
          type: integer
          format: int64
          description: Total number of items across all pages
        content:
          type: array
          description: List of items on this page
          items:
            $ref: '#/components/schemas/V1DatasetEntry'
        first:
          type: boolean
          description: Whether this is the first page
        last:
          type: boolean
          description: Whether this is the last page
        numberOfElements:
          type: integer
          format: int32
          description: Number of items on this page
  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_