Dregs Events API

openapi: 3.2.0
info:
  title: Dregs Events 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: Events
  description: Event tracking and management endpoints
paths:
  /api/events:
    get:
      tags:
      - Events
      summary: List tracked events
      description: Returns paginated list of tracked events for the current team
      operationId: listEvents
      parameters:
      - name: request
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/V1ListEventsRequest'
      responses:
        '200':
          description: Events retrieved successfully
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1PageV1TrackedEvent'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1PageV1TrackedEvent'
      security:
      - secretKey: []
    post:
      tags:
      - Events
      summary: Receive tracking event
      description: Receive a tracking event. Authenticate with a secret key (sk_) for server-side calls or a public key (pk_) for the browser tracker. Include an id to make the write idempotent.
      operationId: trackEvent
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1TrackRequest'
        required: true
      responses:
        '200':
          description: Event received successfully
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1TrackResponse'
        '400':
          description: Invalid event data
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1TrackResponse'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1TrackResponse'
        '402':
          description: Monthly event limit exceeded
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1TrackResponse'
        '429':
          description: Per-credential ingestion rate limit exceeded
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1TrackResponse'
        '500':
          description: Internal server error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1TrackResponse'
      security:
      - secretKey: []
      - publicKey: []
  /api/events/{id}:
    get:
      tags:
      - Events
      summary: Get event
      description: Get a single tracked event by ID
      operationId: getEvent
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Event found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1TrackedEvent'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1TrackedEvent'
        '404':
          description: Event not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1TrackedEvent'
      security:
      - secretKey: []
components:
  schemas:
    V1GroupReference:
      type: object
      description: Reference to a group with its type, ID, label, and API path
      properties:
        type:
          type: string
          description: The group's type, normalized to lower_snake_case
          example: organization
        id:
          type: string
          description: The group's ID in your system
          example: org_678
        label:
          type: string
          description: The group's display name, if known
          example: Acme Inc
        path:
          type: string
          description: API path to the group resource
          example: /api/groups/organization/org_678
    V1TrackResponse:
      type: object
      properties:
        status:
          type: string
        id:
          type: string
        fingerprint:
          type: string
    V1TrackRequestGroup:
      type: object
      properties:
        type:
          type: string
        id:
          type: string
        data:
          type: object
          additionalProperties: {}
    V1PageV1TrackedEvent:
      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/V1TrackedEvent'
        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
    V1TrackedEvent:
      type: object
      description: Tracked event information
      properties:
        id:
          type: string
        timestamp:
          type: string
          format: date-time
        identity:
          $ref: '#/components/schemas/V1Reference'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/V1GroupReference'
        fingerprint:
          type: string
        session:
          type: string
        ip:
          type: string
        url:
          type: string
        eventSource:
          type: string
        eventName:
          type: string
        canonicalType:
          type: string
          enum:
          - REGISTRATION
          - LOGIN
          - LOGIN_FAILED
          - LOGOUT
          - PASSWORD_RESET
          - PASSWORD_CHANGE
          - EMAIL_CONFIRMATION
          - OTP_REQUEST
          - PROFILE_UPDATE
          - RESOURCE_CREATE
          - RESOURCE_UPDATE
          - RESOURCE_RETRIEVE
          - RESOURCE_DELETE
          - MESSAGE_SEND
          - EMAIL_SEND
          - INVITATION_SEND
          - PURCHASE
          - PAYMENT_ATTEMPT
          - REFUND_REQUEST
          - PROMO_REDEEM
          - PAGE_VIEW
          - SEARCH
          - CONTENT_POST
          - FILE_UPLOAD
          - MISCELLANEOUS
        eventData:
          type: object
          additionalProperties: {}
    V1TrackRequest:
      type: object
      properties:
        type:
          type: string
          minLength: 1
        data:
          type: object
          additionalProperties: {}
        identity:
          $ref: '#/components/schemas/V1TrackRequestIdentity'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/V1TrackRequestGroup'
        device:
          $ref: '#/components/schemas/V1TrackRequestDevice'
        key:
          type: string
        timestamp:
          type: string
          format: date-time
        source:
          type: string
        id:
          type: string
          description: Optional client-supplied event ID for idempotent ingestion. When provided, repeated posts with the same ID are silently deduplicated against the previous event for the customer. Must not start with "dregs-" and must be at most 64 characters. When omitted, the server generates a dregs-{UUID} identifier.
          example: stripe_evt_1Q3abc
      required:
      - data
      - type
    V1TrackRequestDevice:
      type: object
      properties:
        signature:
          type: string
        data:
          type: object
          additionalProperties: {}
    V1ListEventsRequest:
      type: object
      properties:
        pageNumber:
          type: integer
          format: int32
          minimum: 0
        pageSize:
          type: integer
          format: int32
          maximum: 100
          minimum: 1
        order:
          type: string
          enum:
          - ASC
          - DESC
        sort:
          type: string
        identity:
          type: string
        group:
          type: string
        groupType:
          type: string
        device:
          type: string
        session:
          type: string
        term:
          type: string
    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
    V1TrackRequestIdentity:
      type: object
      properties:
        id:
          type: string
        data:
          type: object
          additionalProperties: {}
  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_