Skip to content

Get Tap Report

GET
/api/creative/plot/tap-report

Get entities overdue for mention based on configurable tap intervals.

major_interval
Major Interval
integer
default: 3
secondary_interval
Secondary Interval
integer
default: 5
concept_interval
Concept Interval
integer
default: 10

Successful Response

TapReportResponse

Tap report response wrapper.

object
status
required
Status

Operation status

string
data
required
TapReportData

Tap report payload

object
overdue
Overdue
Array<object>
TapReportEntry

An entity that is overdue for a mention.

object
loreEntryId
required
Loreentryid

Entity UUID

string
entityTitle
required
Entitytitle

Entity name

string
importance
required
Importance

Major, secondary, or concept

string
lastSeenNodeId
Any of:
string
lastSeenNodeTitle
Lastseennodetitle

Title of last-seen node

string
""
lastSeenSortOrder
Lastseensortorder

Sort order of last-seen node

integer
0
gap
required
Gap

Number of nodes since last mention

integer
threshold
required
Threshold

Expected tap interval

integer
total
required
Total

Total overdue count

integer

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object