Analysis

The crawler's Analysis result.

interface Analysis {
  // Ownership
  organization: string;
  account: string;
  owner: string;

  // Meta
  id: string;
  version: string;
  status: Status; // "INITIAL" | "DONE" | "ERROR"
  initialTime: string;
  doneTime: string;

  // Parameters
  content: string;
  device: string;
  location: string;

  // Data
  alert: boolean;
  violation: boolean;
  reports: Report[];
}

Fields

Reference

Fields

organization

version  : 1.0.0
stability: stable

organization: string;

The Organization's login that owns this Analysis.

account

version  : 1.0.0
stability: stable

account: string;

The Account's login that owns this Analysis.

owner

version  : 1.0.0
stability: stable

owner: string;

The User's login that owns this Analysis.

id

version  : 1.0.0
stability: stable

id: string;

Base64 encoded version of the pattern used by our API to retrieve an Analysis document.

This identifier is composed by:

  • The entry's type
  • The entry's identifier (UUID)
  • The entry's initial time (yyyy-mm-dd)

These fields are separated using the dash character # and orchestrated as follows:

TYPE#ID#DATE

Example:

// input
analysis#37394e45-c0e4-4343-ae5b-d5c414dac177#2018-04-25

// Base64 version
YW5hbHlzaXMjMzczOTRlNDUtYzBlNC00MzQzLWFlNWItZDVjNDE0ZGFjMTc3IzIwMTgtMDQtMjU=

version

version  : 1.0.0
stability: stable

version: string;

The version follows the Semantic Versioning 2.0.0 specification and reflects the Analysis document shape's version.

status

version  : 1.0.0
stability: stable

status: Status;

enum Status: {
  Initial = "INITIAL",
  Done =  "DONE",
  Error = "ERROR",
};

The Status indicates the progress of an Analysis

initialTime

version  : 1.0.0
stability: stable

initialTime: string;

An ISO 8601 timestamp that reflects the moment when the Analysis request was handled. This value is the one used by default to sort an analysis list.

doneTime

version  : 1.0.0
stability: stable

doneTime: string;

An ISO 8601 timestamp that reflects the moment when the Analysis request was completed. From that time on, the document's data is frozen.

content

version  : 1.0.0
stability: stable

content: string;

The URL or HTML snippet of the content that the user provided to initiate an Analysis. The URL follows the WHATWG URL Standard.

device

version  : 1.0.0
stability: stable

device: string;

It defines the device that has been emulated during the Analysis.

location

version  : 1.0.0
stability: stable

location: string;

The location identifier is composed by:

  • A country (ISO3).
  • A ConnectionType.
  • A provider identifier.

These fields are separated using the dash character # and orchestrated as follows:

COUNTRY#CONNECTION_TYPE#PROVIDER

enum ConnectionType {
  Standard = 'STANDARD',
  Residential = 'RESIDENTIAL',
  Mobile = 'MOBILE',
}

Example:

BEL#MOBILE#ORANGE

alert

version  : 1.0.0
stability: stable

alert: boolean;

It's set to true if one of the Analysis's Report's Detection is positive to an user defined alert.

violation

version  : 1.0.0
stability: stable

violation: boolean;

It's set to true if one of the Analysis's Report's Detection is positive to a violation.

reports

version  : 1.0.0
stability: stable

reports: Report[];

It handles the data generated for each Report during an Analysis.

← TermsAudit →