kb_assessments: Helpers to query AttackerKB assessments

Description Usage Arguments Details References

View source: R/assessments.R

Description

The main kb_contributors function maps 1:1 to the API. Leave values NULL that you do not want included in the search parameters.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
kb_assessments(
  assessment_id = NULL,
  editor_id = NULL,
  topid_id = NULL,
  created = NULL,
  revised = NULL,
  document = NULL,
  metadata = NULL,
  score = NULL,
  q = NULL,
  api_key = attackerkb_api_key()
)

kb_assessment(assessment_id, api_key = attackerkb_api_key())

Arguments

assessment_id

UUID of a specific assessment to return

editor_id

UUID of a contributor.

topid_id

UUID of the topic this assessment was based on.

created

Return all assessments that were created on the given date.

revised

Return all assessments that were revised on the given date.

document

Text to query the document attribute. A substring match is performed

metadata

Text to query the metadata attribute. A substring match is performed

score

Return all assessments with this score.

q

Return all assessments that have content that match the query string.

api_key

See attackerkb_api_key()

Details

Set the option progress_enabled to FALSE to disable progress spinner.

References

https://api.attackerkb.com/api-docs/docs


hrbrmstr/attackerkb documentation built on Oct. 30, 2020, 10:20 a.m.