The saved segments one list follows, in the order it started
following them, in one answer: a plan holds at most 100 watched segments, so the list is not
paginated. Each item carries segment (its id, name, include_sole_traders and
watch), watchlist_id, include_leavers (whether the companies that leave the segment
are delivered as well as those that enter it) and followed_at, the instant the list started
following it: nothing that entered the segment before then is ever delivered.
segment.watch is the one place the API says a segment has stopped delivering. When
the segment's daily update fails three times in a row, the segment is paused for every list
that follows it: paused_at is set, and nothing more is delivered until it is resumed.
failures counts the consecutive failed updates and last_failed_at dates the last one;
both reset on the next success. A pause is mailed to the organization's owners, as a
disabled webhook endpoint is, but no webhook announces it: an integration that watches
these segments unattended should read this list from time to time and alert on a non-null
paused_at. To resume,
follow the segment again, or use Resume on the
segment's page in the console.
allowance is the organization's, across every list: used distinct segments followed
against included, the plan's figure (1 on Free, 10 on Pro, 100 on Scale). A segment two
lists follow counts once. A list that follows no segment answers 200 with an empty
segments; a list that is not your organization's is 404 not_found.
Not counted as a call. Served for fr only; any other country is a 404. A publishable
fk_pub key is refused with 403 public_key_forbidden. What following does is explained
in watch companies.