Skip to main content

Custom API Glossary

TermMeaning
API addressThe origin of your API (https://api.example.com). Every list and detail request stays on it
BatchWhat one sync step adds: the new matches from up to 10 list pages, at most 10,000 documents
Change detectionHow tracked records that changed are found: from Last updated when mapped, otherwise from the mapped title, text and link fields in the list response
ConditionA rule on a record's field (like status Equals open). With Matching records, a record must meet every condition
CursorA pagination style where each response carries a token the next request sends back
Detail pathThe path of one record's full detail, with {id} where the record ID goes
Detail record pathWhere the record is inside the detail response; empty when the response is the record
Document limitMaximum Documents in This Project: the most documents one source may keep, from 1 to 100,000. A lifetime total, never reset
Dot pathA field named by its keys separated by dots, like info.next_page_token
End flagA true/false field in a next-page-link response that says whether more pages exist or the list is done
Fixed query parameterA parameter added to every list request the app builds, like fields=…. A next-page link is followed as given, without it
Has-more flagA true/false field that says whether more pages exist
List endpointThe path that returns records page by page (Records Endpoint Path)
Next-page linkA pagination style where each response carries the address of the next page
OffsetA pagination style where each request skips the records already read
Page numberA pagination style where each request asks for the next page number
PassOne read of the list from its first page to its last. A pass may take several steps
PositionWhere a pass stopped (a cursor, link, page or offset), saved so the next step continues from it
Re-queueMark a tracked record for refreshing because it changed in the list response
Record IDThe field that identifies a record across syncs. Must be present and unique
Response array pathWhere the records are in a list response; empty when the response is the array
Review requiredThe state after an edit to a source's request, conditions, mapping or limit. Nothing syncs until an Owner or Admin reviews and starts it
Scheduled checkThe app reading your API on its own after the first Start: continuing the current pass every 5 minutes, and starting a new pass 15 minutes after one ends
StepOne bounded read of the list: up to 10 pages within about 40 seconds
Tracked recordA record that already has a document in the project