Documentation
  • Overview
  • How It Works
  • Developer API
    • Introduction
    • Initial Test
    • Setup
    • JS SDK
    • HTTPS API
      • Identity
      • Identity Status
      • Signal
    • Webhook
    • User Involvement
    • Bans
    • Boilerplates
      • Node.js
    • Types
      • Identity
      • Signal
      • Event
        • Type
        • Level
        • EventSignal
        • Recommendation
          • Ban
            • Action
          • Type
      • ImmediateResult
      • Identifiers
      • Device
      • Location
      • Carrier
      • IP
      • Tor
      • VPN
      • Approvable
Powered by GitBook
On this page
  1. Developer API
  2. Types

Signal

PreviousIdentityNextEvent

Last updated 2 years ago

A Signal represents one action performed by one . We compare each Signal against past Signals in real-time.

The fields that we accept for a Signal vary depending on the environment from which the Signal was sent. See the page of the HTTPS API documentation to learn more.

Attributes

  • idempotencyKey string Prevent duplicate events by providing a unique key for this signal.

  • type string A custom string value representing the type of event.

  • source enum A string of value 'App' | 'Browser' | 'Server' | 'GoogleFetch' | 'Identity' | 'Unknown'.

  • device Device An object of type.

  • identifiers object An object containing at least one primary and any secondary .

  • ip string The user's IP address.

  • userAgent string The user's user-agent string.

  • lat number The user's latitude coordinate.

  • lon number The user's longitude coordinate.

  • metadata object Custom metadata that was provided with this Signal.

  • time number A Unix timestamp (ms) representing the original time of the action associated with this Signal.

Identity
Signal
Device
Identifiers