Table of Contents
  1. JSON
  2. XML
  3. Input Parameters
  4. Response Parameters
  5. Javascript Library

/Intelligence/Get

Allows the client to get open intelligence based on input search parameters. You can search on endpoint, vector, protocol, classification, code or time interval. You can leave input fields empty. Only fields with non-empty values will restrict the result set in the search. Use the offset and max count arguments to implement pagination.

JSON

Request
{
	"endpoint": Optional(Str(PEndpoint)),
	"vector": Optional(Str(PVector)),
	"protocol": Optional(Str(PProtocol)),
	"classification": Optional(Str(PClassification)),
	"code": Optional(Str(PCode)),
	"from": Optional(DateTime(PFrom)),
	"to": Optional(DateTime(PTo)),
	"offset": Optional(Integer(POffset >= 0)),
	"maxCount": Optional(Integer(0 < PMaxCount <= 100))
}
Response (if successful)
{
	"ResultSet": Optional(
		{
			"objectId": Required(Str(PObjectId)),
			"domain": Optional(Str(PDomain)),
			"endpoint": Required(Str(PEndpoint)),
			"timestamp": Required(DateTimeUtc(PTimestamp)),
			"expires": Required(DateTimeUtc(PExpires)),
			"vector": Optional(Str(PVector)),
			"protocol": Optional(Str(PProtocol)),
			"classification": Optional(Str(PClassification)),
			"code": Optional(Str(PCode)),
			"message": Optional(Str(PMessage)),
			"Tags": Optional(
			{
				"name": Required(Str(PTagName)),
				"value": Optional(PTagValue),
				"type": Optional(Str(PTagType))
			}
			[]),
			"AgentInformation": Optional(
			{
				"name": Required(Str(PAgentPropertyName)),
				"value": Optional(Str(PAgentPropertyValue))
			}
			[])
		}
		[])
}

XML

Request
<GetIntelligence xmlns="https://waher.se/Schema/BrokerAgent.xsd"
	             endpoint=(Optional(Str(PEndpoint)))
	             vector=(Optional(Str(PVector)))
	             protocol=(Optional(Str(PProtocol)))
	             classification=(Optional(Str(PClassification)))
	             code=(Optional(Str(PCode)))
	             from=(Optional(DateTime(PFrom)))
	             to=(Optional(DateTime(PTo)))
	             offset=(Optional(Integer(POffset >= 0)))
				 maxCount=(Optional(Integer(0 < PMaxCount <= 100))) />
Response (if successful)
<IntelligenceSet xmlns="https://waher.se/Schema/BrokerAgent.xsd">
	<ResultSet>
		<[<Information objectId=(Required(Str(PObjectId)))
									 endpoint=(Required(Str(PEndpoint))) 
									 timestamp=(Required(DateTimeUtc(PTimestamp))) 
									 expires=(Required(DateTimeUtc(PExpires))) 
									 vector=(Optional(Str(PVector))) 
									 protocol=(Optional(Str(PProtocol))) 
									 classification=(Optional(Str(PClassification))) 
									 code=(Optional(Str(PCode))) 
									 message=(Optional(Str(PMessage)))>
					<Tags>
						<[
						<Tag name=(Required(Str(PTagName))) 
								 value=(Optional(Str(PTagValue))) 
								 type=(Optional(Str(PTagType))) />[]
						]>
					</Tags>
					<AgentInformation>
						<[
						<AgentProperty name=(Required(Str(PAgentPropertyName))) 
													 value=(Optional(Str(PAgentPropertyValue))) />[]
						]>
					</AgentInformation>
				</Information>[]
			]>
		</ResultSet>
	</IntelligenceSet>

Input Parameters

Parameter Description
PEndpoint Restrict search to this endpoint.
PVector Restrict search to this vector.
PProtocol Restrict search to this protocol.
PClassification Restrict search to this classification.
PCode Restrict search to this code.
PFrom Restrict search to information generated after this point in time (inclusive).
PTo Restrict search to information generated before this point in time (inclusive).
POffset Ignore the first POffset number of information records.
PMaxCount Maximum number of records to return.

Response Parameters

Parameter Description
PObjectId Object ID of information record.
PEndpoint Endpoint to which information relates.
PTimestamp When information was recorded.
PExpires When information expires.
PVector Information about threat vector.
PProtocol Information about communication protocol protocol.
PClassification Information about classification.
PCode Information about code.
PMessage Information message.
PTagName Name of information meta-data tag.
PTagValue Value of information meta-data tag.
PTagType Type of information meta-data tag.
PAgentPropertyName Name of property of agent recording the information.
PAgentPropertyValue Value of property of agent recording the information.

Javascript Library

Use the following asynchronous method in the Javascript Library, to call this resource. 

var Response = await AgentAPI.Intelligence.Get(Endpoint,Vector,Protocol,Classification,Code,From,To,Offset,MaxCount);
Test










Request Payload:

Response Payload: