Enterprise Recon v1 API

Match Summary

Use this set of APIs to retrieve a summary of matches found during scans.

Match History

Get a summary of the entire scan history across all Targets within a given time frame. Results will be returned for each day in the specified time frame in terms of Unix time stamp and number of matches found. The results are sorted according to the Unix time stamp, with the most recent scan displayed first.

Request

GET

https://er-master:8339/v1/summary/history

Authorization

Basic Authentication

Query Parameters

Parameter Data Type Description
offset

integer <days>

default: 0

 For offset=N, the start date for fetching match data is current date - N days. If no value is specified or offset=0, the query retrieves match data starting from the current date and continues for the preceding X number of days (length=X)
limit

integer <days>

default: 1000

 Maximum number of days of match data to retrieve, starting from the date determined by the offset value.

Header Parameters

Parameter Data Type Description
Accept-Encoding

string

enum: gzip deflate

 Specify the compression algorithm to use on the response object.
Compressed content will not be returned for endpoints that return reports as files (e.g. PDF, CSV etc), endpoints that return binary files (e.g. Node Agent installers) or unsuccessful API calls.

Request Samples

HTTP 
GET /v1/summary/history
Accept: application/json
cURL 
curl --request GET 'https://er-master:8339/v1/summary/history' \
--user apiuser:password123 \
--header "Accept: application/json"

Response Schema

200 OK
Response Item Data Type Description
timestamp

number

Time stamp of the scan in Unix time format. The most recent data set will be listed first.
matches

string

Sum of matches with data privacy breaches and matches containing prohibited PCI data.

Response Samples

200 OK 
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
[
  {
    "timestamp": 1523894400,
    "matches": "823700"
  },
  {
    "timestamp": 1523808000,
    "matches": "763302"
  }
]

Summary of Total Matches

Get a summary of total matches found across all Targets that have been scanned to-date. Results provide a breakdown of matches by match status.

Request

GET

https://er-master:8339/v1/summary/totalmatches

Authorization

Basic Authentication

Request Samples

HTTP 
GET /v1/summary/totalmatches
Accept: application/json
cURL 
curl --request GET 'https://er-master:8339/v1/summary/totalmatches' \
--user apiuser:password123 \
--header "Accept: application/json"

Response Schema

200 OK
Response Item Data Type Description
target_count

string

Total number of Targets across all Groups scanned to-date.
matches

object

Breakdown of matches across all Targets by match type.
matches/test

string

Total number of matches containing test data patterns.
matches/match

string

Total number of matches with data privacy breach patterns.
matches/prohibited

string

Total number of matches containing prohibited PCI data patterns.

Response Samples

200 OK 
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
[
  "target_count": "6",
  "matches": {
    "test": "126",
    "match": "8237",
    "prohibited": "10"
  }
]

Get Match Count by Group

Get a summary of match count by Group from all scans to-date. The match count is the sum of matches with data privacy breaches and matches containing prohibited PCI data. Users can choose to retrieve data for specific Groups based on compliance status.

Request

GET

https://er-master:8339/v1/summary/groups

Authorization

Basic Authentication

Query Parameters

Parameter Data Type Description
compliance

string

default: all

enum: all compliant non-compliant not-scanned

 Filter results to list Groups with specific compliance status. If no value is specified or compliance=all, the query retrieves match data for all Groups.
offset

integer

default: 0

 The first Group to return match data for. For offset=N, match data will be fetched starting from Group N. If no value is specified or offset=0, the query retrieves match data starting from Group 1. Groups are sorted by match count in descending order, so the Group with the highest match count will have the lowest index number (0).
limit

integer

default: 1000

 Maximum number of Groups to return match data for, starting from the first Group determined by the offset value.

Header Parameters

Parameter Data Type Description
Accept-Encoding

string

enum: gzip deflate

 Specify the compression algorithm to use on the response object.
Compressed content will not be returned for endpoints that return reports as files (e.g. PDF, CSV etc), endpoints that return binary files (e.g. Node Agent installers) or unsuccessful API calls.

Request Samples

HTTP 
GET /v1/summary/groups
Accept: application/json
cURL 
curl --request GET 'https://er-master:8339/v1/summary/groups' \
--user apiuser:password123 \
--header "Accept: application/json"

Response Schema

200 OK
Response Item Data Type Description
id

string

Unique Group ID. This ID is unique 20 digit number.
name

string

Group name.
matches

string

Sum of matches with data privacy breaches and matches containing prohibited PCI data for the Group.
compliance

string

enum: all compliant non-compliant not-scanned

 Indicates Group compliance status.

Response Samples

200 OK 
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
[
  {
    "id": "11158271480689426083",
    "name": "Linux Group",
    "matches": "643172",
    "compliance": "non-compliant"
  },
  {
    "id": "4838093354730319999",
    "name": "Default Group",
    "matches": "120130",
    "compliance": "non-compliant"
  },
  {
    "id": "11240858805963116603",
    "name": "Websites",
    "matches": "0",
    "compliance": "compliant"
  }
]

Get Match Count by Target

Get a summary of match count by Target from all scans to-date. The match count is the sum of matches with data privacy breaches and matches containing prohibited PCI data. Users can choose to retrieve data for specific Target based on compliance status.

Request

GET

https://er-master:8339/v1/summary/targets

Authorization

Basic Authentication

Query Parameters

Parameter Data Type Description
compliance

string

default: all

enum: all compliant non-compliant not-scanned

 Filter results to list Targets with specific compliance status. If no value is specified or compliance=all, the query retrieves match data for all Targets.
offset

integer

default: 0

 The first Target to return match data for. For offset=N, match data will be fetched starting from Target N. If no value is specified or offset=0, the query retrieves match data starting from Target 1. Targets are sorted by match count in descending order, so the Target with the highest match count will have the lowest index number (0).
limit

integer

default: 1000

 Maximum number of Targets to return match data for, starting from the first Target determined by the offset value.

Header Parameters

Parameter Data Type Description
Accept-Encoding

string

enum: gzip deflate

 Specify the compression algorithm to use on the response object.
Compressed content will not be returned for endpoints that return reports as files (e.g. PDF, CSV etc), endpoints that return binary files (e.g. Node Agent installers) or unsuccessful API calls.

Request Samples

HTTP 
GET /v1/summary/targets
Accept: application/json
cURL 
curl --request GET 'https://er-master:8339/v1/summary/targets' \
--user apiuser:password123 \
--header "Accept: application/json"

Response Schema

200 OK
Response Item Data Type Description
id

string

Unique Target ID. This ID is unique 20 digit number.
name

string

Target name.
matches

string

Sum of matches with data privacy breaches and matches containing prohibited PCI data for the Target.
compliance

string

enum: all compliant non-compliant not-scanned

 Indicates Target compliance status.

Response Samples

200 OK 
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
[
  {
    "id": "2486556466149932561",
    "name": "Example.com",
    "matches": "0",
    "compliance": "compliant"
  },
  {
    "id": "1563630061562709112",
    "name": "MyWebsite.com",
    "matches": "0",
    "compliance": "not-scanned"
  },
  {
    "id": "5776191921548943090",
    "name": "My-Windows-Machine",
    "matches": "429",
    "compliance": "non-compliant"
  }
]

Get Match Count by Target Type

Get summary of match count by type of Target type (e.g. local files, local process memory, websites, databases etc...) from all scans to-date. The match count is the sum of matches with data privacy breaches and matches containing prohibited PCI data. The results are sorted by match count in descending order.

Request

GET

https://er-master:8339/v1/summary/targettypes

Authorization

Basic Authentication

Header Parameters

Parameter Data Type Description
Accept-Encoding

string

enum: gzip deflate

 Specify the compression algorithm to use on the response object.
Compressed content will not be returned for endpoints that return reports as files (e.g. PDF, CSV etc), endpoints that return binary files (e.g. Node Agent installers) or unsuccessful API calls.

Request Samples

HTTP 
GET /v1/summary/targettypes
Accept: application/json
cURL 
curl --request GET 'https://er-master:8339/v1/summary/targettypes' \
--user apiuser:password123 \
--header "Accept: application/json"

Response Schema

200 OK
Response Item Data Type Description
name

string

Type of Target location (e.g. local files, local process memory, websites, databases).
matches

string

Sum of matches with data privacy breaches and matches containing prohibited PCI data for the Target type.

Response Samples

200 OK 
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
[
    {
        "name": "file",
        "matches": "1690817678"
    },
    {
        "name": "dropboxbiz",
        "matches": "811591414"
    },
    {
        "name": "share",
        "matches": "43522263"
    },
    {
        "name": "gmail",
        "matches": "13832069"
    },
    {
        "name": "onedrive",
        "matches": "9451666"
    },
    {
        "name": "hdfs",
        "matches": "4617744"
    },
    {
        "name": "office365",
        "matches": "569008"
    },
    {
        "name": "memory",
        "matches": "401216"
    },
    {
        "name": "gdoc",
        "matches": "285796"
    },
    {
        "name": "mssql",
        "matches": "60261"
    },
    {
        "name": "awss",
        "matches": "109"
    },
    {
        "name": "spdb",
        "matches": "10"
    }
]

Get Match Count by File Format

Get summary of match count by file format or content type (e.g. ZIP archive, HTML/XML document, Rich Text Document) from all scans to-date. The match count is the sum of matches with data privacy breaches and matches containing prohibited PCI data. The results are sorted by match count in descending order.

Request

GET

https://er-master:8339/v1/summary/fileformats

Authorization

Basic Authentication

Header Parameters

Parameter Data Type Description
Accept-Encoding

string

enum: gzip deflate

 Specify the compression algorithm to use on the response object.
Compressed content will not be returned for endpoints that return reports as files (e.g. PDF, CSV etc), endpoints that return binary files (e.g. Node Agent installers) or unsuccessful API calls.

Request Samples

HTTP 
GET /v1/summary/fileformats
Accept: application/json
cURL 
curl --request GET 'https://er-master:8339/v1/summary/fileformats' \
--user apiuser:password123 \
--header "Accept: application/json"

Response Schema

200 OK
Response Item Data Type Description
format

string

File format or content type (e.g. ZIP archive, HTML/XML document, Rich Text Document).
matches

string

Sum of matches with data privacy breaches and matches containing prohibited PCI data for the file format or content type.

Response Samples

200 OK 
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
[
    {
        "format": "ZIP Archive",
        "matches": "25375404"
    },
    {
        "format": "MIME Email",
        "matches": "25016235"
    },
    {
        "format": "UTF8 Encoded Text with BOM",
        "matches": "11903785"
    },
    {
        "format": "MBOX Mail Database",
        "matches": "11002376"
    },
    {
        "format": "HTML/XML Document",
        "matches": "10348933"
    },
    {
        "format": "UNIX Tape Archive",
        "matches": "5843027"
    },
    {
        "format": "GZip Archive",
        "matches": "5305544"
    },
    {
        "format": "BZip2 Archive",
        "matches": "3417819"
    },
    {
        "format": "Microsoft Office Document",
        "matches": "2380911"
    },
    {
        "format": "XZ Archive",
        "matches": "2314565"
    },
    {
        "format": "UNIX AR Archive",
        "matches": "2250182"
    },
    {
        "format": "UTF16 Encoded Text",
        "matches": "1888887"
    },
    {
        "format": "SQLite Database",
        "matches": "1294703"
    },
    {
        "format": "Adobe Portable Document",
        "matches": "1255973"
    },
    {
        "format": "Outlook Mail Database",
        "matches": "1065334"
    },
    {
        "format": "Rich Text Document",
        "matches": "558682"
    },
    {
        "format": "HTML/XML Document (Windows 1252)",
        "matches": "402037"
    },
    {
        "format": "LZMA Archive",
        "matches": "393415"
    },
    {
        "format": "Microsoft Exchange Database",
        "matches": "297190"
    },
    {
        "format": "Microsoft SQL Server Database",
        "matches": "258452"
    },
    {
        "format": "7Zip intermediate stream",
        "matches": "208706"
    },
    {
        "format": "7zip Archive",
        "matches": "188480"
    },
    {
        "format": "EGG Archive",
        "matches": "179832"
    },
    {
        "format": "ALZ Archive",
        "matches": "179832"
    },
    {
        "format": "UTF16/BE Encoded Text",
        "matches": "171201"
    },
    {
        "format": "Microsoft Access Database",
        "matches": "145029"
    },
    {
        "format": "RAR Archive",
        "matches": "121210"
    },
    {
        "format": "Lotus Notes Database",
        "matches": "113883"
    },
    {
        "format": "DBase Database",
        "matches": "84920"
    },
    {
        "format": "LZMA Stream Archive",
        "matches": "81348"
    },
    {
        "format": "UNIX Compress Archive",
        "matches": "70903"
    },
    {
        "format": "UNIX ELF Application",
        "matches": "61307"
    },
    {
        "format": "Outlook Express Database",
        "matches": "58184"
    },
    {
        "format": "Mac mail export",
        "matches": "55076"
    },
    {
        "format": "JPG Image",
        "matches": "53073"
    },
    {
        "format": "ISO Disk Image",
        "matches": "11273"
    },
    {
        "format": "BMP Image",
        "matches": "3200"
    },
    {
        "format": "Microsoft Backup Archive",
        "matches": "1624"
    },
    {
        "format": "Adobe Postscript Document",
        "matches": "723"
    },
    {
        "format": "Portable Executable Application",
        "matches": "501"
    },
    {
        "format": "WAV Media",
        "matches": "147"
    },
    {
        "format": "PNG Image",
        "matches": "25"
    }
]