Schemas
APIError
codeMachine-readable error code such as invalid_request, unauthorized, or not_found.
messageHuman-readable explanation of the failure.
ErrorResponse
EventCollectionResponse
Collection pagination. Send next_cursor unchanged as the next request cursor. The response does not include a cursor echo field.
EventDetailResponse
Event detail record. Collection Event fields plus conditional links and counts.
Pagination
limitPage size requested for this response.
num_resultsCount of records in this page, not a total-match count.
next_cursorOpaque continuation token. Send unchanged as the next request cursor.
SignalCollectionResponse
Collection pagination. Send next_cursor unchanged as the next request cursor. The response does not include a cursor echo field.
SignalDetailResponse
Signal detail record. Collection Signal fields plus conditional links and counts.
SourceCollectionResponse
Collection pagination. Send next_cursor unchanged as the next request cursor. The response does not include a cursor echo field.
DiscoveryValueCollectionResponse
Collection pagination. Send next_cursor unchanged as the next request cursor. The response does not include a cursor echo field.
EventDocument
idStable Event identifier.
kindResource kind. Always event for Event records.
created_atRecord creation time, not occurrence or publication time.
tagsStable tag list used for fuzzy filtering.
summaryConditional short description of the Event.
Conditional Source provenance when available.
key_pointsConditional key points for the Event.
driversConditional drivers for the Event.
impactsConditional impacts of the Event.
impacted_domainsConditional impacted domains.
impact_levelConditional impact-level label.
future_outlookConditional outlook text.
categoriesConditional category labels.
companiesConditional company names.
regionsConditional region names.
peopleConditional people names.
productsConditional product names.
event_typeConditional Event type label.
macro_contextConditional macro-context text.
EventEvidence
base_urlcreated_atidkindsource_idtagsurlEventEvidenceCollectionResponse
Collection pagination. Send next_cursor unchanged as the next request cursor. The response does not include a cursor echo field.
SignalDocument
idStable Signal identifier.
kindResource kind. Always signal for Signal records.
created_atRecord creation time, not forecast or occurrence time.
tagsStable tag list used for fuzzy filtering.
summaryConditional short description of the Signal.
key_pointsConditional key points for the Signal.
driversConditional drivers for the Signal.
impactsConditional impacts of the Signal.
impacted_domainsConditional impacted domains.
impact_levelConditional impact-level label.
future_outlookConditional outlook text.
categoriesConditional category labels.
companiesConditional company names.
regionsConditional region names.
peopleConditional people names.
productsConditional product names.
confidenceConditional confidence label.
SourceDocument
domainidurldescriptionfavicon_urlnamerss_feed_urlSourceItemResponse
Links
evidenceactionseventssignalsCounts
evidenceactionseventssignalsEventDetail
idStable Event identifier.
kindResource kind. Always event for Event records.
created_atRecord creation time, not occurrence or publication time.
tagsStable tag list used for fuzzy filtering.
summaryConditional short description of the Event.
Conditional Source provenance when available.
key_pointsConditional key points for the Event.
driversConditional drivers for the Event.
impactsConditional impacts of the Event.
impacted_domainsConditional impacted domains.
impact_levelConditional impact-level label.
future_outlookConditional outlook text.
categoriesConditional category labels.
companiesConditional company names.
regionsConditional region names.
peopleConditional people names.
productsConditional product names.
event_typeConditional Event type label.
macro_contextConditional macro-context text.
Conditional follow-up paths for a selected Event or Signal.
Conditional related-record counts for a selected Event or Signal.
SignalDetail
idStable Signal identifier.
kindResource kind. Always signal for Signal records.
created_atRecord creation time, not forecast or occurrence time.
tagsStable tag list used for fuzzy filtering.
summaryConditional short description of the Signal.
key_pointsConditional key points for the Signal.
driversConditional drivers for the Signal.
impactsConditional impacts of the Signal.
impacted_domainsConditional impacted domains.
impact_levelConditional impact-level label.
future_outlookConditional outlook text.
categoriesConditional category labels.
companiesConditional company names.
regionsConditional region names.
peopleConditional people names.
productsConditional product names.
confidenceConditional confidence label.
Conditional follow-up paths for a selected Event or Signal.
Conditional related-record counts for a selected Event or Signal.
ZuploProblemDetails
typeURI identifying the problem type. Occurrences of the same problem share this value.
titleStable human-readable summary for this problem type.
statusHTTP status code duplicated in the body.
detailOptional explanation of this occurrence.
instanceRequest path that produced the error.
Zuplo trace extension for correlating the error with gateway logs.

