Tuesday, July 16, 2024

Client - AVM Batch
Action:
GET
Method:
GET
URL: /api/v1/client/adversemedia/batch/get
Description: Fetch the most recent AVM Batch Run information
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Client AVM Batch information
{
 "ClientID": 123,
 "ClientName": "Client ABC",
 "BusinessUnitID": 15,
 "BusinessUnitName": "London Office",
 "AdverseMediaBatchEngineID": "149",
 "StartDate": "2024-07-16 12:00:00",
 "EndDate": "2024-07-16 12:15:00",
 "SearchesPerformed": 208,
 "InitialMatchesFound": 1680,
 "MatchesDiscountedMultiMatch": 0,
 "MatchesDiscountedAlreadyExisting": 0,
 "InitialMatchesDiscountedTotal": 0,
 "ClientEntityMatchVolume": 156,
 "TotalMatches": 1680,
}
Field Data Type
ClientID Int 16
ClientName Text 150
BusinessUnitID Int 32
BusinessUnitName Test 255
AdverseMediaBatchEngineID Int 32
StartDate DateTime
EndDate DateTime
SearchesPerformed Int 32
InitialMatchesFound Int 32
MatchesDiscountedMultiMatch Int 32
MatchesDiscountedAlreadyExisting Int 32
InitialMatchesDiscountedTotal Int 32
ClientEntityMatchVolume Int 32
TotalMatches Int 32