Get Last Week Statistics

This service is used to view the statistics of searches in the last 1 week. The information required to perform the service call is the name of the person to be interrogated. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

Token Informations
Parameter Name Data Type Requirement Description
username String Yes

Api Username Info

password String Yes

Api Password Info

Output Informations
Parameter Name Data Type Description
HttpStatusCode Int

Transaction Result Code

200: Success

400: Unsuccess

IsSuccess Boolean

Transaction Result

True: Success

False: Unsuccess

ErrorCode String

Error Code

ErrorMessage String

Error Message

ExtraInfo String

Extra Information

Result Result Class

Result Information. The following internal table describes the internal parameters.

Result Class Informations
Parameter Name Data Type Description
TotalSearchCount Integer

Count Of All Searches

AlertedSearchCount Integer

Count Of Alerted Searches

Date DateTime

Statistic Day Date

https://api.sanctionscanner.com/api/Reports/GetLastWeekStatistics

The result of the call is a result and the status of the transaction is returned in response. In successful transactions , this status returns to 200, and in unsuccessful transactions it returns to 400.

Sample Service Request Codes

 

//Request 
GET /api/Reports/GetLastWeekStatistics  

//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": [
        {
            "TotalSearchCount": 13,
            "AlertedSearchCount": 10,
            "Date": "01.01.2020"
        },
        {
            "TotalSearchCount": 13,
            "AlertedSearchCount": 10,
            "Date": "31.12.2019"
        }
    ]
}
                    

Get Statistics With Date Range

This service is used to view the statistics of searches in the last 1 month. The information required to perform the service call is the name of the person to be interrogated. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

Token Informations
Parameter Name Data Type Requirement Description
username String Yes

Api Username Info

password String Yes

Api Password Info

Input Informations
Parameter Name Data Type Requriment Description
StartDate DateTime Yes

Start Date

EndDate DateTime Yes

End Date

Output Informations
Parameter Name Data Type Description
HttpStatusCode Int

Transaction Result Code

200: Success

400: Unsuccess

IsSuccess Boolean

Transaction Result

True: Success

False: Unsuccess

ErrorCode String

Error Code

ErrorMessage String

Error Message

ExtraInfo String

Extra Information

Result Result Class

Result Information. The following internal table describes the internal parameters.

Result Class Informations
Parameter Name Data Type Description
TotalSearchCount Integer

Count Of All Searches

AlertedSearchCount Integer

Count Of Alerted Searches

Date DateTime

Statistic Day Date

https://api.sanctionscanner.com/api/Reports/GetStatisticsWithDateRange?StartDate=startdate&EndDate=enddate

The result of the call is a result and the status of the transaction is returned in response. In successful transactions , this status returns to 200, and in unsuccessful transactions it returns to 400.

Sample Service Request Codes

 

//Request 
GET /api/Reports/GetStatisticsWithDateRange?StartDate=startdate&EndDate=enddate 

//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": [
        {
            "TotalSearchCount": 13,
            "AlertedSearchCount": 10,
            "Date": "01.01.2020"
        },
        {
            "TotalSearchCount": 13,
            "AlertedSearchCount": 10,
            "Date": "31.12.2019"
        }
    ]
}