The event
id is the same one Research a part and BOM analysis
return in their events, so an agent can open any event it was handed.
List events
country: ISO 3166-1 alpha-2 code, for exampleCN.region:Asia-Pacific,Europe,North America,Middle East,Latin America,AfricaorGlobal. These group supply-chain news, not the UN regions on distributors; to match the two, filter bycountry.category: a component category such assemiconductors,bearingsorlogistics. The full list is on the reference page, and a value outside it answers400with the list.days: only events first recorded in the last 1 to 90 days. Omit it for every active event.limit(1 to 100, default 50) andcursor: whennext_cursoris not null, call again withcursorset to it for the next page.
One event
severityis how serious the event is in itself, not its effect on any one of your parts. For that, use Research a part or BOM analysis.report_statusis how firm the reporting is:confirmed,developing,probable,rumor, orrisk(a warning about something that has not happened).lead_timeis the added lead time for affected shipments. When a report states one,sourcecarries the sentence and its link, andinterpretationsays who reported it. Whensourceisnull,textis an estimate andinterpretationsays so. Relay it as an estimate.shipping_checkis port activity in the event’s country during the event’s week, for events about ports or shipping.source_urlsare news reports of the event.
Which countries are hit
worst_severity, most severe first. It is not every country with an active
event: a country absent here can still have active events, so to answer “what is happening in this
country”, call GET /v1/events?country=. Open the most severe of a country’s listed events with
GET /v1/events/{id} and top_event_id.
Port and sea-route activity
change_from_normal_percent: how a country’s port calls or a sea route’s ship
transits over the latest week compare with their usual level for the same time of year. Negative is
below usual (-96 is 96% below), positive above (108 is more than twice the usual traffic). Each
reading also carries the last day it covers (through) and a sentence saying the same in words. Both
lists run furthest below usual first. A drop at a country’s ports or at a strait delays shipments
through it.
Errors
A filter outside its allowed values answers400 with the allowed values in summary; an unknown event id answers 404 event_not_found. Every code is on the Errors page.