Types

View as markdown

The fields of every response and event type, and the enumerations they use.

Lookup types

IPInfo

The intelligence Synthient holds for an IP address. See the IP API for how each field is derived.

  • Name
    IP
    Type
    netip.Addr
    Description

    The address that was looked up.

  • Name
    Network
    Type
    *Network
    Description

    The network that announces the address, or nil if the API has no network data.

  • Name
    Location
    Type
    *Location
    Description

    The geolocation of the address, or nil if the API has no location data.

  • Name
    Intelligence
    Type
    *Intelligence
    Description

    The risk score and the proxy, VPN, and device observations for the address, or nil if the API has no intelligence data.

Network

  • Name
    ASN
    Type
    int64
    Description

    The autonomous system number, or 0 if the address is not routed.

  • Name
    ISP
    Type
    string
    Description

    The internet service provider that operates the network.

  • Name
    Org
    Type
    string
    Description

    The organization the address is registered to, or empty if unknown.

  • Name
    Domain
    Type
    string
    Description

    The network operator's domain, or empty if unknown.

  • Name
    Type
    Type
    NetworkType
    Description

    The kind of network, such as NetworkTypeResidential. See Enumerations.

  • Name
    AbuseEmail
    Type
    string
    Description

    The operator's abuse contact email, or empty if unknown.

  • Name
    AbusePhone
    Type
    string
    Description

    The operator's abuse contact phone number, or empty if unknown.

Location

  • Name
    Country
    Type
    string
    Description

    The ISO 3166-1 alpha-2 country code.

  • Name
    State
    Type
    string
    Description

    The state or region.

  • Name
    City
    Type
    string
    Description

    The city.

  • Name
    Timezone
    Type
    string
    Description

    The IANA time zone name.

  • Name
    Latitude
    Type
    float64
    Description

    The latitude in degrees.

  • Name
    Longitude
    Type
    float64
    Description

    The longitude in degrees.

  • Name
    GeoHash
    Type
    string
    Description

    The geohash of the coordinates.

Intelligence

Synthient's assessment of an address. See Methodology for how it is built.

  • Name
    RiskScore
    Type
    int
    Description

    The risk of the address, from 0 to 100.

  • Name
    Categories
    Type
    []string
    Description

    The kinds of services seen on the address, such as "RESIDENTIAL_PROXY". New values may be added.

  • Name
    Behavior
    Type
    []string
    Description

    Behaviors observed from the address. New values may be added.

  • Name
    Providers
    Type
    []Provider
    Description

    The proxy, VPN, and anonymizer services seen using the address. An empty list does not mean the address is clean.

  • Name
    Devices
    Type
    []Device
    Description

    The device types seen behind the address.

Provider

A proxy, VPN, or anonymizer service seen using an address.

  • Name
    Name
    Type
    string
    Description

    The service tag, such as "BRIGHTDATA". The API names this field provider. See Service Tags.

  • Name
    Type
    Type
    string
    Description

    The service category.

  • Name
    LastSeen
    Type
    Timestamp
    Description

    When the service was last seen on the address.

Device

A device type seen behind an address.

  • Name
    OS
    Type
    OS
    Description

    The operating system. See Enumerations.

  • Name
    Version
    Type
    string
    Description

    The operating system version.

  • Name
    LastSeen
    Type
    Timestamp
    Description

    When the device was last seen.

Domain types

DomainInfo

The honeypot traffic Synthient has observed for a domain.

  • Name
    Domain
    Type
    string
    Description

    The domain that was looked up.

  • Name
    Status
    Type
    DomainStatus
    Description

    Whether the domain had events in the last 24 hours.

  • Name
    Stats
    Type
    DomainStats
    Description

    Aggregate event counts.

  • Name
    UniqueIPs
    Type
    UniqueIPs
    Description

    Counts of the distinct source addresses.

  • Name
    TimeSeries
    Type
    []TimeSeriesPoint
    Description

    Daily event counts.

  • Name
    TopASN
    Type
    ASNCount
    Description

    The network that sent the most events. It is zero when there are no events.

  • Name
    TopSubdomains
    Type
    []SubdomainCount
    Description

    The most targeted subdomains.

  • Name
    TopPorts
    Type
    []PortCount
    Description

    The most targeted ports.

  • Name
    GeoDistribution
    Type
    []CountryCount
    Description

    Event counts by source country.

  • Name
    HourDOWHeatmap
    Type
    [][]int64
    Description

    The last 30 days of events by UTC day of week and hour, indexed as HourDOWHeatmap[day][hour]. Day 0 is Monday, unlike time.Weekday, where 0 is Sunday.

  • Name
    ActivityStats
    Type
    ActivityStats
    Description

    The hourly activity pattern.

  • Name
    RecentEvents
    Type
    []DomainEvent
    Description

    The most recent events, capped by LookupDomainParams.Limit.

DomainStats

  • Name
    Events24h
    Type
    int64
    Description

    Events in the last 24 hours.

  • Name
    TotalEvents30d
    Type
    int64
    Description

    Events in the last 30 days.

UniqueIPs

The distinct source addresses seen for a domain.

  • Name
    Value24h
    Type
    int64
    Description

    Distinct source addresses in the last 24 hours.

  • Name
    Value30d
    Type
    int64
    Description

    Distinct source addresses in the last 30 days.

  • Name
    Sparkline24h
    Type
    []int64
    Description

    Hourly counts for the last 24 hours.

TimeSeriesPoint

The event counts for one day.

  • Name
    Date
    Type
    Timestamp
    Description

    The start of the day.

  • Name
    Events
    Type
    int64
    Description

    Events that day.

  • Name
    UniqueIPs
    Type
    int64
    Description

    The number of distinct source addresses that day.

ASNCount

  • Name
    ASN
    Type
    int64
    Description

    The autonomous system number.

  • Name
    Events
    Type
    int64
    Description

    Events from that network.

SubdomainCount

  • Name
    Subdomain
    Type
    string
    Description

    The subdomain.

  • Name
    Count
    Type
    int64
    Description

    The number of events that targeted it.

PortCount

  • Name
    Port
    Type
    int
    Description

    The port.

  • Name
    Count
    Type
    int64
    Description

    The number of events that targeted it.

CountryCount

  • Name
    CountryCode
    Type
    string
    Description

    The ISO 3166-1 alpha-2 country code.

  • Name
    Events
    Type
    int64
    Description

    Events from that country.

  • Name
    UniqueIPs
    Type
    int64
    Description

    Distinct source addresses from that country.

ActivityStats

The hourly activity pattern of a domain.

  • Name
    Cadence
    Type
    Cadence
    Description

    How events are spread over the last 30 days. See Enumerations.

  • Name
    MedianPerHour
    Type
    int64
    Description

    The median number of events per hour.

  • Name
    P95PerHour
    Type
    int64
    Description

    The 95th percentile of events per hour.

  • Name
    PeakHour
    Type
    int
    Description

    The busiest UTC hour of the day.

  • Name
    QuietHour
    Type
    int
    Description

    The quietest UTC hour of the day.

DomainEvent

A single honeypot event for a domain.

  • Name
    Timestamp
    Type
    Timestamp
    Description

    When the event happened.

  • Name
    SourceIP
    Type
    string
    Description

    The full proxy exit address that carried the event. The API names the field source_ip_masked, but the address is not masked.

  • Name
    TargetSubdomain
    Type
    string
    Description

    The subdomain that was targeted.

  • Name
    CountryCode
    Type
    string
    Description

    The source country.

  • Name
    Port
    Type
    int
    Description

    The destination port.

Account types

Account

The account that owns the API key.

  • Name
    Email
    Type
    string
    Description

    The account's email address.

  • Name
    FirstName
    Type
    string
    Description

    The account holder's first name.

  • Name
    LastName
    Type
    string
    Description

    The account holder's last name.

  • Name
    Organization
    Type
    Organization
    Description

    The organization the account belongs to.

  • Name
    Scopes
    Type
    []Scope
    Description

    The permissions granted to the API key. See Enumerations.

  • Name
    LookupQuota
    Type
    LookupQuota
    Description

    The remaining lookup credit balance.

  • Name
    APIKey
    Type
    AccountAPIKey
    Description

    The API key used for the request.

Organization

  • Name
    ID
    Type
    string
    Description

    The organization's ID.

  • Name
    Name
    Type
    string
    Description

    The organization's name.

  • Name
    Relation
    Type
    Relation
    Description

    The account's role in the organization. See Enumerations.

LookupQuota

An account's lookup credit balance.

  • Name
    Credits
    Type
    int64
    Description

    The number of lookup credits remaining.

  • Name
    ResetsIn
    Type
    int64
    Description

    The number of seconds until the credits reset.

AccountAPIKey

  • Name
    ID
    Type
    string
    Description

    Identifies the key. It is not the secret key itself.

  • Name
    Name
    Type
    string
    Description

    The key's display name.

  • Name
    CreatedAt
    Type
    time.Time
    Description

    When the key was created.

Export types

ExportPage

One page of a feed's exports, newest first.

  • Name
    Stream
    Type
    string
    Description

    The feed's stream identifier, such as "proxies".

  • Name
    Exports
    Type
    []Export
    Description

    The exports on this page. The API names this field feeds.

  • Name
    NextCursor
    Type
    string
    Description

    Fetches the next page through ListExportsParams.Cursor. It is empty on the last page.

Export

A Parquet export of a feed.

  • Name
    ID
    Type
    string
    Description

    Identifies the export for ExportMeta, Download, and DownloadURL. On the first page, the newest hourly export may have the ID LatestExport.

  • Name
    Kind
    Type
    ExportKind
    Description

    Whether the export covers an hour or a day.

  • Name
    Date
    Type
    string
    Description

    The UTC day of the export as "YYYY-MM-DD".

  • Name
    Hour
    Type
    *int
    Description

    The UTC hour of an hourly export, or nil for a daily export.

  • Name
    SizeBytes
    Type
    int64
    Description

    The size of the Parquet file in bytes.

  • Name
    RowCount
    Type
    int64
    Description

    The number of rows in the file.

  • Name
    Checksum
    Type
    string
    Description

    The hex-encoded SHA-256 of the Parquet file.

  • Name
    CreatedAt
    Type
    Timestamp
    Description

    When the export was created.

  • Name
    DownloadPath
    Type
    string
    Description

    The API path of the export's download, including the version prefix.

ExportMeta

A Parquet export without its contents.

  • Name
    ID
    Type
    string
    Description

    The export ID.

  • Name
    Stream
    Type
    string
    Description

    The feed's stream identifier.

  • Name
    Kind
    Type
    ExportKind
    Description

    Whether the export covers an hour or a day.

  • Name
    Format
    Type
    string
    Description

    The file format, "parquet".

  • Name
    Date
    Type
    Timestamp
    Description

    The start of the export's UTC day or hour.

  • Name
    Hour
    Type
    *int
    Description

    The UTC hour of an hourly export, or nil for a daily export.

  • Name
    Rows
    Type
    int64
    Description

    The number of rows in the file.

  • Name
    Size
    Type
    int64
    Description

    The size of the Parquet file in bytes.

  • Name
    Checksum
    Type
    string
    Description

    The hex-encoded SHA-256 of the Parquet file.

  • Name
    CreatedAt
    Type
    Timestamp
    Description

    When the export was created.

  • Name
    Schema
    Type
    ParquetSchema
    Description

    The Parquet columns.

ParquetSchema

  • Name
    Fields
    Type
    []ParquetColumn
    Description

    The columns in file order.

ParquetColumn

  • Name
    Name
    Type
    string
    Description

    The column name.

  • Name
    Type
    Type
    ParquetType
    Description

    The column type. See Enumerations.

Event types

Stream payloads match the Firehose and Helios documentation field for field. Fields the API omits are left at their zero value.

ProxyEvent

A proxy sighting from the Proxies feed.

  • Name
    IP
    Type
    string
    Description

    The proxy exit address.

  • Name
    Provider
    Type
    string
    Description

    The proxy service tag.

  • Name
    Type
    Type
    ProxyType
    Description

    The service category. See Enumerations.

  • Name
    CountryCode
    Type
    string
    Description

    The ISO 3166-1 alpha-2 country of the address.

  • Name
    ASN
    Type
    int64
    Description

    The autonomous system number of the address.

  • Name
    Timestamp
    Type
    Timestamp
    Description

    When the proxy was seen, in Unix seconds.

AnonymizerEvent

A VPN or anonymizer IP range from the Anonymizers feed.

  • Name
    RangeStart
    Type
    string
    Description

    The first address of the range.

  • Name
    RangeEnd
    Type
    string
    Description

    The last address of the range.

  • Name
    Provider
    Type
    string
    Description

    The service tag.

  • Name
    Type
    Type
    ProxyType
    Description

    The service category, such as ProxyTypeCommercialVPN.

  • Name
    CountryCode
    Type
    string
    Description

    The ISO 3166-1 alpha-2 country of RangeStart.

  • Name
    ASN
    Type
    int64
    Description

    The autonomous system number of RangeStart.

  • Name
    Timestamp
    Type
    Timestamp
    Description

    When the range was seen, in Unix milliseconds.

TorrentEvent

A torrent observed on the BitTorrent DHT or a tracker.

  • Name
    InfoHash
    Type
    string
    Description

    The hex-encoded SHA-1 info hash.

  • Name
    Name
    Type
    string
    Description

    The torrent's name.

  • Name
    MagnetURI
    Type
    string
    Description

    The torrent's magnet link.

  • Name
    TotalSize
    Type
    int64
    Description

    The total size of the torrent's files in bytes.

  • Name
    PieceLength
    Type
    int64
    Description

    The piece size in bytes.

  • Name
    FileCount
    Type
    int
    Description

    The number of files in the torrent.

  • Name
    Files
    Type
    []TorrentFile
    Description

    The files in the torrent.

  • Name
    Peers
    Type
    []TorrentPeer
    Description

    The peers seen sharing the torrent.

  • Name
    Timestamp
    Type
    Timestamp
    Description

    When the torrent was seen, in Unix seconds.

TorrentFile

  • Name
    Path
    Type
    string
    Description

    The file path within the torrent.

  • Name
    Length
    Type
    int64
    Description

    The file size in bytes.

TorrentPeer

  • Name
    IP
    Type
    string
    Description

    The peer's address.

  • Name
    Port
    Type
    int
    Description

    The peer's port.

  • Name
    Source
    Type
    string
    Description

    Where the peer was found, such as "DHT", "PEX", or "tracker".

  • Name
    Encrypted
    Type
    bool
    Description

    Whether the peer supports encrypted connections.

JA4TEvent

A JA4T TCP fingerprint sighting.

  • Name
    IP
    Type
    string
    Description

    The address the fingerprint was seen from.

  • Name
    JA4T
    Type
    string
    Description

    The JA4T fingerprint.

  • Name
    Provider
    Type
    string
    Description

    The service tag of the address.

  • Name
    Type
    Type
    ProxyType
    Description

    The service category, such as ProxyTypeDatacenterProxy.

  • Name
    CountryCode
    Type
    string
    Description

    The ISO 3166-1 alpha-2 country of the address.

  • Name
    ASN
    Type
    int64
    Description

    The autonomous system number of the address.

  • Name
    Timestamp
    Type
    Timestamp
    Description

    When the fingerprint was seen, in Unix seconds.

HeliosMeta

The Helios honeypot sensor that captured an event.

  • Name
    ProxyIP
    Type
    string
    Description

    The proxy exit address the traffic arrived through.

  • Name
    Server
    Type
    string
    Description

    The sensor that captured the traffic.

  • Name
    PoolID
    Type
    string
    Description

    The sensor pool.

  • Name
    Provider
    Type
    string
    Description

    The proxy service the traffic arrived through.

HeliosHTTPEvent

An HTTP request captured by a Helios honeypot.

  • Name
    Timestamp
    Type
    Timestamp
    Description

    When the request was captured, in Unix milliseconds.

  • Name
    TunnelID
    Type
    uint64
    Description

    Identifies the proxy tunnel the request arrived through. Live values use the full uint64 range.

  • Name
    Domain
    Type
    string
    Description

    The host the tunnel was opened to.

  • Name
    Port
    Type
    int
    Description

    The destination port.

  • Name
    Protocol
    Type
    string
    Description

    Always "http".

  • Name
    Meta
    Type
    HeliosMeta
    Description

    The capturing sensor.

  • Name
    Details
    Type
    HTTPRequestDetails
    Description

    The parsed request. It is a struct value, so it is the zero HTTPRequestDetails when the API omits it or sends null.

  • Name
    Raw
    Type
    []byte
    Description

    The raw request bytes, decoded from the API's base64.

HTTPRequestDetails

A parsed HTTP request.

  • Name
    Method
    Type
    string
    Description

    The request method.

  • Name
    URI
    Type
    string
    Description

    The request target.

  • Name
    Version
    Type
    string
    Description

    The HTTP version, such as "HTTP/1.1".

  • Name
    Headers
    Type
    map[string]string
    Description

    The request headers.

HeliosHTTPSEvent

A TLS ClientHello captured by a Helios honeypot.

  • Name
    Timestamp
    Type
    Timestamp
    Description

    When the handshake was captured, in Unix milliseconds.

  • Name
    TunnelID
    Type
    uint64
    Description

    Identifies the proxy tunnel the handshake arrived through. Live values use the full uint64 range.

  • Name
    Domain
    Type
    string
    Description

    The host the tunnel was opened to.

  • Name
    Port
    Type
    int
    Description

    The destination port.

  • Name
    Protocol
    Type
    string
    Description

    Always "https".

  • Name
    Meta
    Type
    HeliosMeta
    Description

    The capturing sensor.

  • Name
    Details
    Type
    *TLSClientHello
    Description

    The parsed ClientHello, or nil if the sensor could not parse the handshake.

  • Name
    Raw
    Type
    string
    Description

    Always empty, because the sensors do not capture handshake bytes.

TLSClientHello

A TLS ClientHello parsed by a Helios sensor. Fields the sensor could not parse are empty.

  • Name
    RecordVersion
    Type
    string
    Description

    The record layer version, such as "TLS 1.0".

  • Name
    HandshakeVersion
    Type
    string
    Description

    The ClientHello version, such as "TLS 1.2".

  • Name
    ClientRandom
    Type
    string
    Description

    The hex-encoded 32-byte client random.

  • Name
    SessionID
    Type
    string
    Description

    The hex-encoded session ID.

  • Name
    SessionIDLength
    Type
    int
    Description

    The length of the session ID in bytes.

  • Name
    CipherSuites
    Type
    []TLSCodeName
    Description

    The offered cipher suites.

  • Name
    CompressionMethods
    Type
    []int
    Description

    The offered compression methods.

  • Name
    Extensions
    Type
    []TLSExtension
    Description

    The extensions in wire order.

  • Name
    SNI
    Type
    string
    Description

    The server_name extension value.

  • Name
    ALPN
    Type
    []string
    Description

    The offered application protocols.

  • Name
    SupportedVersions
    Type
    []string
    Description

    The offered TLS versions.

  • Name
    SupportedGroups
    Type
    []TLSCodeName
    Description

    The offered key exchange groups.

  • Name
    SignatureAlgorithms
    Type
    []TLSCodeName
    Description

    The offered signature algorithms.

  • Name
    ECPointFormats
    Type
    []string
    Description

    The offered elliptic curve point formats.

  • Name
    KeyShareGroups
    Type
    []string
    Description

    The groups the client sent key shares for.

  • Name
    PSKKeyExchangeModes
    Type
    []string
    Description

    The offered pre-shared key exchange modes.

  • Name
    CompressCertificate
    Type
    []string
    Description

    The offered certificate compression algorithms.

  • Name
    HasGREASE
    Type
    bool
    Description

    Whether the ClientHello contains GREASE values.

  • Name
    ApplicationSettings
    Type
    bool
    Description

    Whether the client offered application settings (ALPS).

  • Name
    DelegatedCredentials
    Type
    bool
    Description

    Whether the client offered the delegated_credentials extension.

  • Name
    EncryptThenMAC
    Type
    bool
    Description

    Whether the client offered the encrypt_then_mac extension.

  • Name
    ExtendedMasterSecret
    Type
    bool
    Description

    Whether the client offered the extended_master_secret extension.

  • Name
    PostHandshakeAuth
    Type
    bool
    Description

    Whether the client offered the post_handshake_auth extension.

  • Name
    RenegotiationInfo
    Type
    bool
    Description

    Whether the client offered the renegotiation_info extension.

  • Name
    SignedCertificateTimestamps
    Type
    bool
    Description

    Whether the client offered the signed_certificate_timestamp extension.

  • Name
    StatusRequest
    Type
    bool
    Description

    Whether the client requested OCSP stapling.

TLSCodeName

A TLS registry code point and its name. GREASE values are named "GREASE(0x....)".

  • Name
    Code
    Type
    int
    Description

    The code point.

  • Name
    Name
    Type
    string
    Description

    The code point's registered name.

TLSExtension

An extension in a TLS ClientHello.

  • Name
    Code
    Type
    int
    Description

    The extension type.

  • Name
    Name
    Type
    string
    Description

    The extension's registered name.

  • Name
    Length
    Type
    int
    Description

    The extension body length in bytes.

HeliosDNSEvent

A destination that a Helios honeypot tunnel was asked to reach. Despite the feed's name, it is not a DNS query: names resolved inside a tunneled DNS session are not visible.

  • Name
    Timestamp
    Type
    Timestamp
    Description

    When the event was captured, in Unix milliseconds.

  • Name
    TunnelID
    Type
    uint64
    Description

    Identifies the proxy tunnel. Live values use the full uint64 range.

  • Name
    Domain
    Type
    string
    Description

    The host name or address literal the tunnel was opened to.

  • Name
    Port
    Type
    int
    Description

    The destination port.

  • Name
    Protocol
    Type
    string
    Description

    Always "dns".

  • Name
    Meta
    Type
    HeliosMeta
    Description

    The capturing sensor.

HeliosADBEvent

An Android Debug Bridge shell command captured by a Helios honeypot. It has no timestamp because the sensor sends none.

  • Name
    Session
    Type
    string
    Description

    Identifies the ADB session as 32 hex characters.

  • Name
    SequentialID
    Type
    int64
    Description

    The 1-based position of the command within its session.

  • Name
    Command
    Type
    string
    Description

    The shell command. Invalid UTF-8 bytes are replaced with U+FFFD.

  • Name
    Hash
    Type
    string
    Description

    The hex-encoded SHA-256 the sensor assigns to the session's payload. It is not a hash of Command: every command in a session shares it, and sessions that replay the same script share it too.

Enumerations

Each value set is a named string type with a constant per known value. The API may add values to the sets marked open, so handle unknown values instead of assuming a closed switch.

NetworkType

The kind of network that announces an address. Open.

ConstantValue
NetworkTypeMobileMOBILE
NetworkTypeSatelliteSATELLITE
NetworkTypeInFlightWiFiIN_FLIGHT_WIFI
NetworkTypeResidentialRESIDENTIAL
NetworkTypeCorporateCORPORATE
NetworkTypeAcademicACADEMIC
NetworkTypeDatacenterDATACENTER
NetworkTypeGovernmentGOVERNMENT

ProxyType

The kind of service seen on an address. Open.

ConstantValue
ProxyTypeFreeVPNFREE_VPN
ProxyTypeCommercialVPNCOMMERCIAL_VPN
ProxyTypeEnterpriseVPNENTERPRISE_VPN
ProxyTypeMobileProxyMOBILE_PROXY
ProxyTypeBlockchainProxyBLOCKCHAIN_PROXY
ProxyTypeResidentialProxyRESIDENTIAL_PROXY
ProxyTypePublicProxyPUBLIC_PROXY
ProxyTypeDatacenterProxyDATACENTER_PROXY
ProxyTypeTorNodeTOR_NODE
ProxyTypePrivateRelayPRIVATE_RELAY
ProxyTypeBotnetBOTNET
ProxyTypeSearchEngineSEARCH_ENGINE
ProxyTypeAICrawlerAI_CRAWLER
ProxyTypeSocialMediaSOCIAL_MEDIA
ProxyTypeUptimeMonitorUPTIME_MONITOR
ProxyTypeLinkPreviewLINK_PREVIEW
ProxyTypeSEOCrawlerSEO_CRAWLER
ProxyTypeWebArchiverWEB_ARCHIVER
ProxyTypeWebhookProviderWEBHOOK_PROVIDER
ProxyTypePaymentProcessorPAYMENT_PROCESSOR
ProxyTypeInternetScannerINTERNET_SCANNER

OS

A device operating system. Open.

ConstantValue
OSAndroidAndroid
OSChromeOSChrome OS
OSFreeBSDFreeBSD
OSiOSiOS
OSLinuxLinux
OSMacOSXMac OS X
OSWindowsWindows

Scope

A permission granted to an API key. Open. ScopeBasic authorizes lookups and Account. Each feed has one scope for its exports and one for its stream, as listed under Feeds. See Authentication for how scopes are granted.

ConstantValue
ScopeBasicBASIC
ScopeProxyFeedsPROXY_FEEDS
ScopeProxyFirehosePROXY_FIREHOSE
ScopeAnonymizersFeedANONYMIZERS_FEED
ScopeAnonymizersStreamANONYMIZERS_STREAM
ScopeJA3FeedJA3_FEED
ScopeJA3StreamJA3_STREAM
ScopeTorrentsFeedTORRENTS_FEED
ScopeTorrentsStreamTORRENTS_STREAM
ScopeHoneypotHTTPFeedHONEYPOT_HTTP_FEED
ScopeHoneypotHTTPStreamHONEYPOT_HTTP_STREAM
ScopeHoneypotHTTPSFeedHONEYPOT_HTTPS_FEED
ScopeHoneypotHTTPSStreamHONEYPOT_HTTPS_STREAM
ScopeHoneypotADBFeedHONEYPOT_ADB_FEED
ScopeHoneypotADBStreamHONEYPOT_ADB_STREAM
ScopeHoneypotDNSFeedHONEYPOT_DNS_FEED
ScopeHoneypotDNSStreamHONEYPOT_DNS_STREAM
ScopeJA4FeedJA4_FEED
ScopeJA4StreamJA4_STREAM
ScopeJA4TFeedJA4T_FEED
ScopeJA4TStreamJA4T_STREAM
ScopeAdminProxiesADMIN_PROXIES

Relation

An account's role in its organization.

ConstantValue
RelationOwnerOWNER
RelationAdminADMIN
RelationMemberMEMBER

DomainStatus

Whether a domain has recent activity.

ConstantValueMeaning
DomainStatusActiveactiveThe domain had events in the last 24 hours.
DomainStatusInactiveinactiveThe domain had no events in the last 24 hours, or has never been observed.

Cadence

A sentence describing a domain's activity pattern.

ConstantValue
CadenceNoActivityNo activity in the last 30 days.
CadenceEvenlyDistributedActivity is evenly distributed across the day.
CadenceBusinessHoursActivity follows a weekday business-hours pattern.
CadenceWeekendActivity follows a weekend pattern.
CadenceBurstDrivenActivity is burst-driven with significant peaks.

ExportKind

Whether an export covers an hour or a day.

ConstantValue
ExportKindHourlyhourly
ExportKindDailydaily

ParquetType

The type of a Parquet column. Open.

ConstantValue
ParquetTypeStringstring
ParquetTypeInt64int64
ParquetTypeUint32uint32
ParquetTypeUint64uint64
ParquetTypeBoolbool
ParquetTypeBytesbytes

Timestamps

A Unix time as encoded by the API.

type Timestamp int64
  • Units: It is in seconds, except on anonymizer and Helios HTTP, HTTPS, and DNS stream events, where it is in milliseconds.

Time converts either unit to a time.Time in UTC.

func (t Timestamp) Time() time.Time
  • Units: Values of 1e12 or more are read as milliseconds.
  • Zero value: The zero Timestamp returns the zero time.Time, so absent timestamps report IsZero.