The highest tagged major version is v7.

sdk

package

v3.5.0 Latest Latest Go to latest Published: Nov 27, 2023 License: MIT Imports: 19 Imported by: 1

Documentation ¶

Overview ¶

* Fingerprint Pro Server API * * Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device. * * API version: 3 * Contact: support@fingerprint.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Fingerprint Pro Server API * * Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. This API can be used for data exports, decision-making, and data analysis scenarios. * * API version: 3 * Contact: support@fingerprint.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Fingerprint Pro Server API * * Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device. * * API version: 3 * Contact: support@fingerprint.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func ParseResponse(httpResponse *http.Response, error interface{})
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type Asn
type BasicAuth
type BotdDetectionResult
type BotdResult
type BrowserDetails
type Confidence
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
- func (c *Configuration) ChangeBasePath(path string)
- func (c *Configuration) ChangeRegion(region Region)
- func (c *Configuration) GetBasePath() string
- func (c *Configuration) GetRegion() Region
type DataCenter
type ErrorEvent403Response
type ErrorEvent403ResponseError
type ErrorEvent404Response
type ErrorEvent404ResponseError
type ErrorVisits403
type EventResponse
type FingerprintApiGetVisitsOpts
type FingerprintApiService
- func (a *FingerprintApiService) GetEvent(ctx context.Context, requestId string) (EventResponse, *http.Response, error)
- func (a *FingerprintApiService) GetVisits(ctx context.Context, visitorId string, ...) (Response, *http.Response, error)
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type HighActivityResult
type IdentificationError
type IpBlockListResult
type IpBlockListResultDetails
type IpInfoResult
type IpInfoResultV4
type IpInfoResultV6
type IpLocation
type IpLocationCity
type Location
type LocationSpoofingResult
type ManyRequestsResponse
type Model
type ModelError
type ModelMap
type Object
type ProductError
type ProductsResponse
type ProductsResponseBotd
type ProductsResponseIdentification
type ProductsResponseIdentificationData
type Region
type Response
type ResponseVisits
type SeenAt
type SignalResponseClonedApp
type SignalResponseClonedAppData
type SignalResponseEmulator
type SignalResponseEmulatorData
type SignalResponseFactoryReset
type SignalResponseFactoryResetData
type SignalResponseFrida
type SignalResponseFridaData
type SignalResponseHighActivity
type SignalResponseIncognito
type SignalResponseIncognitoData
type SignalResponseIpBlocklist
type SignalResponseIpInfo
type SignalResponseJailbroken
type SignalResponseJailbrokenData
type SignalResponseLocationSpoofing
type SignalResponsePrivacySettings
type SignalResponsePrivacySettingsData
type SignalResponseProxy
type SignalResponseProxyData
type SignalResponseRawDeviceAttributes
type SignalResponseRootApps
type SignalResponseRootAppsData
type SignalResponseTampering
type SignalResponseTor
type SignalResponseTorData
type SignalResponseVirtualMachine
type SignalResponseVirtualMachineData
type SignalResponseVpn
type Subdivision
type TamperingResult
type Visit
type VpnResult
type VpnResultMethods
type WebhookSignalResponseClonedApp
type WebhookSignalResponseEmulator
type WebhookSignalResponseFactoryReset
type WebhookSignalResponseFrida
type WebhookSignalResponseJailbroken
type WebhookSignalResponsePrivacySettings
type WebhookSignalResponseProxy
type WebhookSignalResponseRootApps
type WebhookSignalResponseTor
type WebhookSignalResponseVirtualMachine
type WebhookVisit

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func ParseResponse ¶

func ParseResponse(httpResponse *http.Response, error interface{})

Types ¶

type APIClient ¶

type APIClient struct {
	FingerprintApi *FingerprintApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Fingerprint Pro Server API API v3 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type Asn ¶ added in v3.4.2

type Asn struct {
	Asn     string `json:"asn"`
	Network string `json:"network"`
	Name    string `json:"name,omitempty"`
}

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BotdDetectionResult ¶

type BotdDetectionResult struct {
	// Bot detection result:  * `notDetected` - the visitor is not a bot  * `good` - good bot detected, such as Google bot, Baidu Spider, AlexaBot and so on  * `bad` - bad bot detected, such as Selenium, Puppeteer, Playwright, headless browsers, and so on
	Result string `json:"result"`
	Type_  string `json:"type,omitempty"`
}

Stores bot detection result

type BotdResult ¶

type BotdResult struct {
	// IP address of the requesting browser or bot.
	Ip string `json:"ip"`
	// Time in UTC when the request from the JS agent was made. We recommend to treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible
	Time *time.Time `json:"time"`
	// Page URL from which identification request was sent.
	Url       string               `json:"url"`
	UserAgent string               `json:"userAgent,omitempty"`
	RequestId string               `json:"requestId,omitempty"`
	Bot       *BotdDetectionResult `json:"bot"`
}

Contains all the information from Bot Detection product

type BrowserDetails ¶

type BrowserDetails struct {
	BrowserName         string `json:"browserName"`
	BrowserMajorVersion string `json:"browserMajorVersion"`
	BrowserFullVersion  string `json:"browserFullVersion"`
	Os                  string `json:"os"`
	OsVersion           string `json:"osVersion"`
	Device              string `json:"device"`
	UserAgent           string `json:"userAgent"`
	BotProbability      int32  `json:"botProbability,omitempty"`
}

type Confidence ¶

type Confidence struct {
	// The confidence score is a floating-point number between 0 and 1 that represents the probability of accurate identification.
	Score float32 `json:"score"`
}

type Configuration ¶

type Configuration struct {
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
	// contains filtered or unexported fields
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

func (*Configuration) ChangeBasePath ¶

func (c *Configuration) ChangeBasePath(path string)

ChangeBasePath Change base path to allow switching to mocks

func (*Configuration) ChangeRegion ¶

func (c *Configuration) ChangeRegion(region Region)

ChangeRegion Changes region and sets basePath for it

func (*Configuration) GetBasePath ¶

func (c *Configuration) GetBasePath() string

func (*Configuration) GetRegion ¶

func (c *Configuration) GetRegion() Region

type DataCenter ¶ added in v3.4.2

type DataCenter struct {
	Result bool   `json:"result"`
	Name   string `json:"name,omitempty"`
}

type ErrorEvent403Response ¶

type ErrorEvent403Response struct {
	Error_ *ErrorEvent403ResponseError `json:"error,omitempty"`
}

type ErrorEvent403ResponseError ¶

type ErrorEvent403ResponseError struct {
	// Error code:  * `TokenRequired` - `Auth-API-Key` header is missing or empty  * `TokenNotFound` - subscription not found for specified secret key  * `SubscriptionNotActive` - subscription is not active  * `WrongRegion` - server and subscription region differ
	Code    string `json:"code"`
	Message string `json:"message"`
}

type ErrorEvent404Response ¶

type ErrorEvent404Response struct {
	Error_ *ErrorEvent404ResponseError `json:"error,omitempty"`
}

type ErrorEvent404ResponseError ¶

type ErrorEvent404ResponseError struct {
	// Error code:  * `RequestNotFound` - request not found for specified id
	Code    string `json:"code"`
	Message string `json:"message"`
}

type ErrorVisits403 ¶

type ErrorVisits403 struct {
	// Error text.
	Error_ string `json:"error"`
}

type EventResponse ¶

type EventResponse struct {
	Products *ProductsResponse `json:"products,omitempty"`
}

Contains results from all activated products - Fingerprint Pro, Bot Detection, and others.

type FingerprintApiGetVisitsOpts ¶

type FingerprintApiGetVisitsOpts struct {
	RequestId     optional.String
	LinkedId      optional.String
	Limit         optional.Int32
	PaginationKey optional.String
	Before        optional.Int64
}

type FingerprintApiService ¶

type FingerprintApiService service

func (*FingerprintApiService) GetEvent ¶

func (a *FingerprintApiService) GetEvent(ctx context.Context, requestId string) (EventResponse, *http.Response, error)

FingerprintApiService Get event by requestId This endpoint allows you to get a detailed analysis of an individual request. **Only for Enterprise customers:** Please note that the response includes mobile signals (e.g. `rootApps`) even if the request orignated from a non-mobile platform. It is highly recommended that you **ignore** the mobile signals for such requests. Use `requestId` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `requestId`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param requestId The unique [identifier](https://dev.fingerprint.com/docs/js-agent#requestid) of each analysis request.

@return EventResponse

func (*FingerprintApiService) GetVisits ¶

func (a *FingerprintApiService) GetVisits(ctx context.Context, visitorId string, localVarOptionals *FingerprintApiGetVisitsOpts) (Response, *http.Response, error)

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type HighActivityResult ¶ added in v3.5.0

type HighActivityResult struct {
	// Flag indicating whether the request came from a high activity visitor.
	Result bool `json:"result,omitempty"`
	// Number of requests from the same visitor in the previous day.
	DailyRequests float64 `json:"dailyRequests,omitempty"`
}

type IdentificationError ¶

type IdentificationError struct {
	// Error code:  * `429 Too Many Requests` - the limit on secret API key requests per second has been exceeded  * `Failed` - internal server error
	Code    string `json:"code"`
	Message string `json:"message"`
}

type IpBlockListResult ¶ added in v3.1.0

type IpBlockListResult struct {
	// `true` if request IP address is part of any database that we use to search for known malicious actors, `false` otherwise.
	Result  bool                      `json:"result,omitempty"`
	Details *IpBlockListResultDetails `json:"details,omitempty"`
}

type IpBlockListResultDetails ¶ added in v3.1.0

type IpBlockListResultDetails struct {
	// IP address was part of a known email spam attack (SMTP).
	EmailSpam bool `json:"emailSpam,omitempty"`
	// IP address was part of a known network attack (SSH/HTTPS).
	AttackSource bool `json:"attackSource,omitempty"`
}

type IpInfoResult ¶ added in v3.1.0

type IpInfoResult struct {
	V4 *IpInfoResultV4 `json:"v4,omitempty"`
	V6 *IpInfoResultV6 `json:"v6,omitempty"`
}

Details about the request IP address. Has separate fields for v4 and v6 IP address versions.

type IpInfoResultV4 ¶ added in v3.1.0

type IpInfoResultV4 struct {
	Address     string      `json:"address,omitempty"`
	Geolocation *IpLocation `json:"geolocation,omitempty"`
	Asn         *Asn        `json:"asn,omitempty"`
	DataCenter  *DataCenter `json:"dataCenter,omitempty"`
}

type IpInfoResultV6 ¶ added in v3.1.0

type IpInfoResultV6 struct {
	Address     string      `json:"address,omitempty"`
	Geolocation *IpLocation `json:"geolocation,omitempty"`
	Asn         *Asn        `json:"asn,omitempty"`
	DataCenter  *DataCenter `json:"dataCenter,omitempty"`
}

type IpLocation ¶

type IpLocation struct {
	// The IP address is likely to be within this radius (in km) of the specified location.
	AccuracyRadius int32           `json:"accuracyRadius,omitempty"`
	Latitude       float64         `json:"latitude,omitempty"`
	Longitude      float64         `json:"longitude,omitempty"`
	PostalCode     string          `json:"postalCode,omitempty"`
	Timezone       string          `json:"timezone,omitempty"`
	City           *IpLocationCity `json:"city,omitempty"`
	Country        *Location       `json:"country,omitempty"`
	Continent      *Location       `json:"continent,omitempty"`
	Subdivisions   []Subdivision   `json:"subdivisions,omitempty"`
}

type IpLocationCity ¶

type IpLocationCity struct {
	Name string `json:"name,omitempty"`
}

type Location ¶

type Location struct {
	Code string `json:"code"`
	Name string `json:"name"`
}

type LocationSpoofingResult ¶ added in v3.5.0

type LocationSpoofingResult struct {
	// Flag indicating whether the request came from a device with location spoofing enabled.
	Result bool `json:"result,omitempty"`
}

type ManyRequestsResponse ¶

type ManyRequestsResponse struct {
	// Error text.
	Error_     string `json:"error"`
	RetryAfter int64
}

type Model ¶

type Model struct{}

type ModelError ¶ added in v3.4.0

type ModelError struct {
	Name    string `json:"name"`
	Message string `json:"message"`
}

type ModelMap ¶

type ModelMap map[string]string

type Object ¶ added in v3.4.0

type Object map[string]interface{}

type ProductError ¶ added in v3.1.0

type ProductError struct {
	// Error code:  * `TooManyRequests` - the limit on secret API key requests per second has been exceeded  * `Failed` - internal server error
	Code    string `json:"code"`
	Message string `json:"message"`
}

type ProductsResponse ¶

type ProductsResponse struct {
	Identification      *ProductsResponseIdentification    `json:"identification,omitempty"`
	Botd                *ProductsResponseBotd              `json:"botd,omitempty"`
	IpInfo              *SignalResponseIpInfo              `json:"ipInfo,omitempty"`
	Incognito           *SignalResponseIncognito           `json:"incognito,omitempty"`
	RootApps            *SignalResponseRootApps            `json:"rootApps,omitempty"`
	Emulator            *SignalResponseEmulator            `json:"emulator,omitempty"`
	ClonedApp           *SignalResponseClonedApp           `json:"clonedApp,omitempty"`
	FactoryReset        *SignalResponseFactoryReset        `json:"factoryReset,omitempty"`
	Jailbroken          *SignalResponseJailbroken          `json:"jailbroken,omitempty"`
	Frida               *SignalResponseFrida               `json:"frida,omitempty"`
	IpBlocklist         *SignalResponseIpBlocklist         `json:"ipBlocklist,omitempty"`
	Tor                 *SignalResponseTor                 `json:"tor,omitempty"`
	PrivacySettings     *SignalResponsePrivacySettings     `json:"privacySettings,omitempty"`
	VirtualMachine      *SignalResponseVirtualMachine      `json:"virtualMachine,omitempty"`
	Vpn                 *SignalResponseVpn                 `json:"vpn,omitempty"`
	Proxy               *SignalResponseProxy               `json:"proxy,omitempty"`
	Tampering           *SignalResponseTampering           `json:"tampering,omitempty"`
	HighActivity        *SignalResponseHighActivity        `json:"highActivity,omitempty"`
	LocationSpoofing    *SignalResponseLocationSpoofing    `json:"locationSpoofing,omitempty"`
	RawDeviceAttributes *SignalResponseRawDeviceAttributes `json:"rawDeviceAttributes,omitempty"`
}

Contains all information about the request identified by `requestId`, depending on the pricing plan (Pro, Pro Plus, Enterprise)

type ProductsResponseBotd ¶

type ProductsResponseBotd struct {
	Data   *BotdResult   `json:"data,omitempty"`
	Error_ *ProductError `json:"error,omitempty"`
}

type ProductsResponseIdentification ¶

type ProductsResponseIdentification struct {
	Data   *ProductsResponseIdentificationData `json:"data,omitempty"`
	Error_ *IdentificationError                `json:"error,omitempty"`
}

type ProductsResponseIdentificationData ¶

type ProductsResponseIdentificationData struct {
	// Unique identifier of the user's identification request.
	RequestId      string          `json:"requestId"`
	BrowserDetails *BrowserDetails `json:"browserDetails"`
	// Flag if user used incognito session.
	Incognito  bool        `json:"incognito"`
	Ip         string      `json:"ip"`
	IpLocation *IpLocation `json:"ipLocation,omitempty"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp int64 `json:"timestamp"`
	// Time expressed according to ISO 8601 in UTC format.
	Time *time.Time `json:"time"`
	// Page URL from which identification request was sent.
	Url string `json:"url"`
	// A customer-provided value or an object that was sent with identification request.
	Tag ModelMap `json:"tag,omitempty"`
	// A customer-provided id that was sent with identification request.
	LinkedId   string      `json:"linkedId,omitempty"`
	Confidence *Confidence `json:"confidence"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound bool    `json:"visitorFound"`
	FirstSeenAt  *SeenAt `json:"firstSeenAt"`
	LastSeenAt   *SeenAt `json:"lastSeenAt"`
	// String of 20 characters that uniquely identifies the visitor's browser.
	VisitorId string `json:"visitorId"`
}

type Region ¶

type Region string

const (
	RegionEU   Region = "eu"
	RegionUS   Region = "us"
	RegionAsia Region = "asia"
)

type Response ¶

type Response struct {
	VisitorId string           `json:"visitorId"`
	Visits    []ResponseVisits `json:"visits"`
	// ⚠️ Deprecated paging attribute, please use `paginationKey` instead. Timestamp of the last visit in the current page of results.
	LastTimestamp int64 `json:"lastTimestamp,omitempty"`
	// Request ID of the last visit in the current page of results. Use this value in the following request as the `paginationKey` parameter to get the next page of results.
	PaginationKey string `json:"paginationKey,omitempty"`
}

Fields `lastTimestamp` and `paginationKey` added when `limit` or `before` parameter provided and there is more data to show

type ResponseVisits ¶

type ResponseVisits struct {
	// Unique identifier of the user's identification request.
	RequestId      string          `json:"requestId"`
	BrowserDetails *BrowserDetails `json:"browserDetails"`
	// Flag if user used incognito session.
	Incognito  bool        `json:"incognito"`
	Ip         string      `json:"ip"`
	IpLocation *IpLocation `json:"ipLocation,omitempty"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp int64 `json:"timestamp"`
	// Time expressed according to ISO 8601 in UTC format.
	Time *time.Time `json:"time"`
	// Page URL from which identification request was sent.
	Url string `json:"url"`
	// A customer-provided value or an object that was sent with identification request.
	Tag ModelMap `json:"tag"`
	// A customer-provided id that was sent with identification request.
	LinkedId   string      `json:"linkedId,omitempty"`
	Confidence *Confidence `json:"confidence"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound bool    `json:"visitorFound"`
	FirstSeenAt  *SeenAt `json:"firstSeenAt"`
	LastSeenAt   *SeenAt `json:"lastSeenAt"`
}

type SeenAt ¶

type SeenAt struct {
	Global       *time.Time `json:"global"`
	Subscription *time.Time `json:"subscription"`
}

type SignalResponseClonedApp ¶ added in v3.3.0

type SignalResponseClonedApp struct {
	Data   *SignalResponseClonedAppData `json:"data,omitempty"`
	Error_ *ProductError                `json:"error,omitempty"`
}

type SignalResponseClonedAppData ¶ added in v3.3.0

type SignalResponseClonedAppData struct {
	// Android specific cloned application detection. There are 2 values: • `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). • `false` - No signs of cloned application detected or the client is not Android.
	Result bool `json:"result,omitempty"`
}

type SignalResponseEmulator ¶ added in v3.1.0

type SignalResponseEmulator struct {
	Data   *SignalResponseEmulatorData `json:"data,omitempty"`
	Error_ *ProductError               `json:"error,omitempty"`
}

type SignalResponseEmulatorData ¶ added in v3.1.0

type SignalResponseEmulatorData struct {
	// Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected or the client is not Android.
	Result bool `json:"result,omitempty"`
}

type SignalResponseFactoryReset ¶ added in v3.3.0

type SignalResponseFactoryReset struct {
	Data   *SignalResponseFactoryResetData `json:"data,omitempty"`
	Error_ *ProductError                   `json:"error,omitempty"`
}

type SignalResponseFactoryResetData ¶ added in v3.3.0

type SignalResponseFactoryResetData struct {
	// Time in UTC for the Android client when recent factory reset was done.  If there is no sign of factory reset or the client isn't Android, the field will be epoch time.
	Time *time.Time `json:"time,omitempty"`
	// Same value as it's in the `time` field but represented in timestamp format.
	Timestamp int64 `json:"timestamp,omitempty"`
}

type SignalResponseFrida ¶ added in v3.3.0

type SignalResponseFrida struct {
	Data   *SignalResponseFridaData `json:"data,omitempty"`
	Error_ *ProductError            `json:"error,omitempty"`
}

type SignalResponseFridaData ¶ added in v3.3.0

type SignalResponseFridaData struct {
	// iOS specific [Frida](https://frida.re/docs/ios/) detection. There are 2 values: • `true` - Frida detected • `false` - No signs of Frida or the client is not iOS.
	Result bool `json:"result,omitempty"`
}

type SignalResponseHighActivity ¶ added in v3.5.0

type SignalResponseHighActivity struct {
	Data   *HighActivityResult `json:"data,omitempty"`
	Error_ *ProductError       `json:"error,omitempty"`
}

type SignalResponseIncognito ¶ added in v3.1.0

type SignalResponseIncognito struct {
	Data   *SignalResponseIncognitoData `json:"data,omitempty"`
	Error_ *ProductError                `json:"error,omitempty"`
}

type SignalResponseIncognitoData ¶ added in v3.1.0

type SignalResponseIncognitoData struct {
	// `true` if we detected incognito mode used in the browser, `false` otherwise.
	Result bool `json:"result,omitempty"`
}

type SignalResponseIpBlocklist ¶ added in v3.1.0

type SignalResponseIpBlocklist struct {
	Data   *IpBlockListResult `json:"data,omitempty"`
	Error_ *ProductError      `json:"error,omitempty"`
}

type SignalResponseIpInfo ¶ added in v3.1.0

type SignalResponseIpInfo struct {
	Data   *IpInfoResult `json:"data,omitempty"`
	Error_ *ProductError `json:"error,omitempty"`
}

type SignalResponseJailbroken ¶ added in v3.3.0

type SignalResponseJailbroken struct {
	Data   *SignalResponseJailbrokenData `json:"data,omitempty"`
	Error_ *ProductError                 `json:"error,omitempty"`
}

type SignalResponseJailbrokenData ¶ added in v3.3.0

type SignalResponseJailbrokenData struct {
	// iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.
	Result bool `json:"result,omitempty"`
}

type SignalResponseLocationSpoofing ¶ added in v3.5.0

type SignalResponseLocationSpoofing struct {
	Data   *LocationSpoofingResult `json:"data,omitempty"`
	Error_ *ProductError           `json:"error,omitempty"`
}

type SignalResponsePrivacySettings ¶ added in v3.3.0

type SignalResponsePrivacySettings struct {
	Data   *SignalResponsePrivacySettingsData `json:"data,omitempty"`
	Error_ *ProductError                      `json:"error,omitempty"`
}

type SignalResponsePrivacySettingsData ¶ added in v3.3.0

type SignalResponsePrivacySettingsData struct {
	// `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.
	Result bool `json:"result,omitempty"`
}

type SignalResponseProxy ¶ added in v3.1.0

type SignalResponseProxy struct {
	Data   *SignalResponseProxyData `json:"data,omitempty"`
	Error_ *ProductError            `json:"error,omitempty"`
}

type SignalResponseProxyData ¶ added in v3.1.0

type SignalResponseProxyData struct {
	// `true` if the request IP address is used by a public proxy provider, `false` otherwise.
	Result bool `json:"result,omitempty"`
}

type SignalResponseRawDeviceAttributes ¶ added in v3.4.0

type SignalResponseRawDeviceAttributes struct {
	Data *map[string]interface{} `json:"data,omitempty"`
}

type SignalResponseRootApps ¶ added in v3.1.0

type SignalResponseRootApps struct {
	Data   *SignalResponseRootAppsData `json:"data,omitempty"`
	Error_ *ProductError               `json:"error,omitempty"`
}

type SignalResponseRootAppsData ¶ added in v3.1.0

type SignalResponseRootAppsData struct {
	// Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected or the client is not Android.
	Result bool `json:"result,omitempty"`
}

type SignalResponseTampering ¶ added in v3.1.0

type SignalResponseTampering struct {
	Data   *TamperingResult `json:"data,omitempty"`
	Error_ *ProductError    `json:"error,omitempty"`
}

type SignalResponseTor ¶ added in v3.1.0

type SignalResponseTor struct {
	Data   *SignalResponseTorData `json:"data,omitempty"`
	Error_ *ProductError          `json:"error,omitempty"`
}

type SignalResponseTorData ¶ added in v3.1.0

type SignalResponseTorData struct {
	// `true` if the request IP address is a known tor exit node, `false` otherwise.
	Result bool `json:"result,omitempty"`
}

type SignalResponseVirtualMachine ¶ added in v3.3.0

type SignalResponseVirtualMachine struct {
	Data   *SignalResponseVirtualMachineData `json:"data,omitempty"`
	Error_ *ProductError                     `json:"error,omitempty"`
}

type SignalResponseVirtualMachineData ¶ added in v3.3.0

type SignalResponseVirtualMachineData struct {
	// `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise.
	Result bool `json:"result,omitempty"`
}

type SignalResponseVpn ¶ added in v3.1.0

type SignalResponseVpn struct {
	Data   *VpnResult    `json:"data,omitempty"`
	Error_ *ProductError `json:"error,omitempty"`
}

type Subdivision ¶

type Subdivision struct {
	IsoCode string `json:"isoCode,omitempty"`
	Name    string `json:"name,omitempty"`
}

type TamperingResult ¶ added in v3.1.0

type TamperingResult struct {
	// Flag indicating whether browser tampering was detected according to our internal thresholds.
	Result bool `json:"result,omitempty"`
	// Confidence score (`0.0 - 1.0`) for the tampering detection. Values above `0.5` suggest that we're reasonably sure there was a tampering attempt. Values below `0.5` are genuine browsers.
	AnomalyScore float64 `json:"anomalyScore,omitempty"`
}

type Visit ¶

type Visit struct {
	// Unique identifier of the user's identification request.
	RequestId      string          `json:"requestId"`
	BrowserDetails *BrowserDetails `json:"browserDetails"`
	// Flag if user used incognito session.
	Incognito  bool        `json:"incognito"`
	Ip         string      `json:"ip"`
	IpLocation *IpLocation `json:"ipLocation,omitempty"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp int64 `json:"timestamp"`
	// Time expressed according to ISO 8601 in UTC format.
	Time *time.Time `json:"time"`
	// Page URL from which identification request was sent.
	Url string `json:"url"`
	// A customer-provided value or an object that was sent with identification request.
	Tag ModelMap `json:"tag,omitempty"`
	// A customer-provided id that was sent with identification request.
	LinkedId   string      `json:"linkedId,omitempty"`
	Confidence *Confidence `json:"confidence"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound bool    `json:"visitorFound"`
	FirstSeenAt  *SeenAt `json:"firstSeenAt"`
	LastSeenAt   *SeenAt `json:"lastSeenAt"`
}

type VpnResult ¶ added in v3.1.0

type VpnResult struct {
	// VPN or other anonymizing service has been used when sending the request.
	Result bool `json:"result,omitempty"`
	// Local timezone which is used in timezoneMismatch method.
	OriginTimezone string            `json:"originTimezone,omitempty"`
	Methods        *VpnResultMethods `json:"methods,omitempty"`
}

type VpnResultMethods ¶ added in v3.1.0

type VpnResultMethods struct {
	// User's browser timezone doesn't match the timezone from which the request was originally made.
	TimezoneMismatch bool `json:"timezoneMismatch,omitempty"`
	// Request IP address is owned and used by a public VPN service provider.
	PublicVPN bool `json:"publicVPN,omitempty"`
	// This method applies to mobile devices only. Indicates the result of additional methods used to detect a VPN in mobile devices.
	AuxiliaryMobile bool `json:"auxiliaryMobile,omitempty"`
}

type WebhookSignalResponseClonedApp ¶ added in v3.3.0

type WebhookSignalResponseClonedApp struct {
	// Android specific cloned application detection. There are 2 values: • `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). • `false` - No signs of cloned application detected or the client is not Android.
	Result bool `json:"result,omitempty"`
}

type WebhookSignalResponseEmulator ¶ added in v3.1.0

type WebhookSignalResponseEmulator struct {
	// Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected or the client isn't Android.
	Result bool `json:"result,omitempty"`
}

type WebhookSignalResponseFactoryReset ¶ added in v3.3.0

type WebhookSignalResponseFactoryReset struct {
	// Time in UTC for the Android client when recent factory reset was done.  If there is no sign of factory reset or the client isn't Android, the field will be epoch time.
	Time *time.Time `json:"time,omitempty"`
	// Same value as it's in the `time` field but represented in timestamp format.
	Timestamp int64 `json:"timestamp,omitempty"`
}

type WebhookSignalResponseFrida ¶ added in v3.3.0

type WebhookSignalResponseFrida struct {
	// iOS specific [Frida](https://frida.re/docs/ios/) detection. There are 2 values: • `true` - Frida detected • `false` - No signs of Frida or the client is not iOS.
	Result bool `json:"result,omitempty"`
}

type WebhookSignalResponseJailbroken ¶ added in v3.3.0

type WebhookSignalResponseJailbroken struct {
	// iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.
	Result bool `json:"result,omitempty"`
}

type WebhookSignalResponsePrivacySettings ¶ added in v3.3.0

type WebhookSignalResponsePrivacySettings struct {
	// `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.
	Result bool `json:"result,omitempty"`
}

type WebhookSignalResponseProxy ¶ added in v3.1.0

type WebhookSignalResponseProxy struct {
	// `true` if the request IP address is used by a public proxy provider, `false` otherwise.
	Result bool `json:"result,omitempty"`
}

type WebhookSignalResponseRootApps ¶ added in v3.1.0

type WebhookSignalResponseRootApps struct {
	// Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected or the client isn't Android.
	Result bool `json:"result,omitempty"`
}

type WebhookSignalResponseTor ¶ added in v3.1.0

type WebhookSignalResponseTor struct {
	// `true` if the request IP address is a known tor exit node, `false` otherwise.
	Result bool `json:"result,omitempty"`
}

type WebhookSignalResponseVirtualMachine ¶ added in v3.3.0

type WebhookSignalResponseVirtualMachine struct {
	// `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise.
	Result bool `json:"result,omitempty"`
}

type WebhookVisit ¶

type WebhookVisit struct {
	VisitorId      string               `json:"visitorId"`
	ClientReferrer string               `json:"clientReferrer,omitempty"`
	UserAgent      string               `json:"userAgent,omitempty"`
	Bot            *BotdDetectionResult `json:"bot,omitempty"`
	IpInfo         *IpInfoResult        `json:"ipInfo,omitempty"`
	// Flag if user used incognito session.
	Incognito           bool                                  `json:"incognito"`
	RootApps            *WebhookSignalResponseRootApps        `json:"rootApps,omitempty"`
	Emulator            *WebhookSignalResponseEmulator        `json:"emulator,omitempty"`
	ClonedApp           *WebhookSignalResponseClonedApp       `json:"clonedApp,omitempty"`
	FactoryReset        *WebhookSignalResponseFactoryReset    `json:"factoryReset,omitempty"`
	Jailbroken          *WebhookSignalResponseJailbroken      `json:"jailbroken,omitempty"`
	Frida               *WebhookSignalResponseFrida           `json:"frida,omitempty"`
	IpBlocklist         *IpBlockListResult                    `json:"ipBlocklist,omitempty"`
	Tor                 *WebhookSignalResponseTor             `json:"tor,omitempty"`
	PrivacySettings     *WebhookSignalResponsePrivacySettings `json:"privacySettings,omitempty"`
	VirtualMachine      *WebhookSignalResponseVirtualMachine  `json:"virtualMachine,omitempty"`
	Vpn                 *VpnResult                            `json:"vpn,omitempty"`
	Proxy               *WebhookSignalResponseProxy           `json:"proxy,omitempty"`
	Tampering           *TamperingResult                      `json:"tampering,omitempty"`
	RawDeviceAttributes *map[string]interface{}               `json:"rawDeviceAttributes,omitempty"`
	HighActivity        *HighActivityResult                   `json:"highActivity,omitempty"`
	LocationSpoofing    *LocationSpoofingResult               `json:"locationSpoofing,omitempty"`
	// Unique identifier of the user's identification request.
	RequestId      string          `json:"requestId"`
	BrowserDetails *BrowserDetails `json:"browserDetails"`
	Ip             string          `json:"ip"`
	IpLocation     *IpLocation     `json:"ipLocation,omitempty"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp int64 `json:"timestamp"`
	// Time expressed according to ISO 8601 in UTC format.
	Time *time.Time `json:"time"`
	// Page URL from which identification request was sent.
	Url string `json:"url"`
	// A customer-provided value or an object that was sent with identification request.
	Tag ModelMap `json:"tag,omitempty"`
	// A customer-provided id that was sent with identification request.
	LinkedId   string      `json:"linkedId,omitempty"`
	Confidence *Confidence `json:"confidence"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound bool    `json:"visitorFound"`
	FirstSeenAt  *SeenAt `json:"firstSeenAt"`
	LastSeenAt   *SeenAt `json:"lastSeenAt"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL