Notyfi trackers API
The trackers API from Notyfi — 6 operation(s) for trackers.
Notyfi trackers API is one of 5 APIs that Notyfi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include trackers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 8 operations across 6 paths, and defines 37 schemas. It is described by OpenAPI 3.1.0, at version 1.2.0.
Requests are made against a single base URL, https://api.notyfi.com.
8 operations
6 paths
37 schemas
1 DELETE4 GET1 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Notyfi trackers API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
An API key is passed in the header as X-Api-Key (apiKeyAuth).
By default, every request must be authenticated.
bearerAuth— Notyfi API key: Authorization: Bearer notyfimk...apiKeyAuth— Notyfi API key as X-Api-Key.
Paths & Operations 8
Across 6 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
trackers 8
POST
/api/v1/trackers
Create a Notyfi tracker
GET
/api/v1/trackers
List the caller's Notyfi trackers
GET
/api/v1/trackers/{public_id}
Get one tracker by opaque public id
DELETE
/api/v1/trackers/{public_id}
Archive a tracker by opaque public id
GET
/api/v1/trackers/{public_id}/progress
Get tracker research/build progress by opaque public id
GET
/api/v1/trackers/{public_id}/events
List a live tracker's canonical events by opaque public id
PATCH
/api/v1/trackers/{public_id}/delivery
Update tracker delivery by opaque public id
POST
/api/v1/trackers/{public_id}/retry
Retry a stalled tracker by opaque public id
Schemas 37
The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are FeedRequest (18 properties), FeedSpec (14 properties), FeedRunStats (13 properties), SchemaField (12 properties). Each schema is shown below with its type and property counts.
FeedProgressEntry
object
One legible line in a feed request's LIVE research trail (append-only): a UTC timestamp + the human-readable line ('probed - socrata 5 rows OK', 'excluded : ro…
2 properties
1 required
TimestampsBlock
object
The feed's timestamp roles. All three name datetime-typed fields in fields.
3 properties
1 required
FeedRequestState
string
Where a feed request is in its lifecycle. USER-visible: submitted - researching - specready - {ratified, declined} - building - live; refused is the honest-ref…
ValidationError
object
5 properties
3 required
FeedScope
object
The ratified scope: what an EVENT is, the in/out examples, and the geographic/freshness bounds.
4 properties
1 required
WriteMode
string
Error
object
The single error response shape for every 4xx/5xx on the contract.
1 property
1 required
LifecycleBlock
object
End-state declaration: when statusfield lands in terminalstates the event is finished.
2 properties
2 required
EntityRole
string
Semantic entity typing for role='entity' fields (acquirer/target, buyer/seller, ...).
BillingCadence
string
FeedMonitorState
object
The LIVE MONITOR READ for an observe feed (feedmonitorstate, 2026-07-19): the current value the last check saw + when it was seen + when the feed last checked…
3 properties
Page_FeedEvent_
object
3 properties
EnginePin
object
Which acquisition-engine recipe runs this feed's search stage, pinned per feed. The pin is what makes engine rollouts safe: a spec without one (everything comp…
3 properties
1 required
FieldType
string
The closed value-type vocabulary of a schema field.
ErrorBody
object
3 properties
2 required
SourceFormat
string
How a source is fetched/parsed. rss/api/socrata/csv/search/observe are MACHINE-READABLE (v0-includable catalog rows, zero codegen; an observe source is a FROZE…
AcceptanceExample
object
One in/out scope example: a concrete candidate item + whether the ratified scope includes it. The ~20 of these ARE the executable definition of the feed's boun…
2 properties
2 required
UncertaintyBias
string
The DECLARED dedup cost asymmetry the adjudication prompts encode (documentation that is load-bearing in prompt TEXT, never branched on -- mirrors IdentityPatt…
HTTPValidationError
object
1 property
FeedDeliveryUpdate
object
Owner-scoped notification preference patch for one tracker.
2 properties
EventSchema
object
The per-feed extraction OUTPUT CONTRACT (design v1 §3): the declared fields, the identity key, the timestamp roles, the write mode, and the ordered null-tolera…
7 properties
4 required
FeedRunStats
object
The latest feedruns ledger row for a building/live feed (the build ticker the frontend renders): the fetch/extract/dedup counts + the run status. Read from the…
13 properties
SourceTier
string
Source truth tier (T1 = authoritative/primary ... T4 = weakest corroboration).
FeedRequestCreate
object
The intake body: the NL query (8..500 chars) + the scoping answers. Submitting creates a request in state submitted; everything after that is the concierge loo…
4 properties
1 required
SchemaField
object
One declared output field. description is REQUIRED -- it doubles as the extraction prompt line, so it must say what to extract AND any source normalization ('e…
12 properties
3 required
SourceStatus
string
A researched source's disposition on the Coverage Report. include = a live v0 catalog row; the rest are the HONEST exclusions (refusal-grade transparency, not…
SpecSource
object
One researched source as a catalog row: where it is, how it reads, its truth tier, and its v0 disposition. Every non-include row carries WHY (the Coverage Repo…
9 properties
5 required
DedupPolicy
object
The feed's dedup identity model, declared: the keyer pattern, the same-X adjudication prompt skeleton (agents fill parameters, never invent identity theory), a…
4 properties
3 required
FeedRequest
object
A tenant-owned feed request (the read shape). spec is the compiled :class:~crawler.feedspec.FeedSpec -- null until the concierge attaches it (state specready);…
18 properties
4 required
FeedOntology
object
The feed's entity/event vocabulary + the identity pattern that keys its entities.
4 properties
3 required
FeedEvent
object
The current OPEN head of one deduplicated feed event. id is the stable canonical event id. revision hashes the exact event-and-evidence snapshot used by feed n…
12 properties
3 required
FeedSpec
object
The canonical, versioned create-a-feed artifact: everything the generic engine needs to run one feed, and everything the partner ratifies. A feed IS its spec.
14 properties
6 required
FeedScopeAnswers
object
The short intake scoping form riding a feed request: what's an EVENT, the geography/filter bound, and the freshness expectation -- each in the user's plain wor…
3 properties
FieldRole
string
ADVISORY semantic role (non-unique): rendering/UX hints, never branched on by the engine.
FeedBudget
object
The per-feed-run HARD CAPS the runtime enforces (create-a-feed v0 rule: a quote without a breaker is a liability). costband remains the human-readable prose qu…
4 properties
FeedRequestProgress
object
LIVE progress for a feed request so researching/building are not dead air: the research probe-trail (append-only, persisted as the agent probes/proposes/dry-ru…
10 properties
2 required
FeedEventSource
object
One observation supporting a canonical consumer-feed event revision.
8 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Notyfi 4
Other APIs Notyfi publishes across the network.
Notyfi account API
Notyfi billing API
Notyfi keys API
Notyfi webhooks API
#trackers