Glossary
Data API glossary
The terms you will meet when you turn files into an API and let others query it, explained simply, with how Feedvault uses each one.
Files and data
- CSV
- Comma-separated values: a plain text table with one record per line. The most common export format for spreadsheets.
- JSON
- JavaScript Object Notation: a text format for structured data with types. API responses are usually JSON.
- Dataset
- A named collection of records with a schema. In Feedvault, each dataset has its own records, schema, provenance and keys.
- Record
- One row of data, such as one product.
- Schema
- The list of columns with their types and rules (required, key, searchable).
- Schema inference
- Guessing each column's type from the data. Feedvault infers types on import; you review them.
- Normalisation
- Converting values to a consistent form, such as "AED 52.50" to 52.5 or different date formats to one.
- Provenance
- A note on where data came from and who maintains it. Every Feedvault dataset has one.
Importing and updating
- Key column
- A column whose value uniquely identifies a record, such as a SKU.
- Upsert
- Update the record if its key exists, insert it otherwise. Feedvault imports are upserts by key.
- Change history
- A record of what changed between imports. Feedvault keeps one per dataset.
- Import slice
- A batch of rows processed in one step. Feedvault imports large files in slices in the background.
APIs and queries
- API
- Application programming interface: a way for programs to request data from another system.
- Endpoint
- A specific address of an API, such as a dataset's records endpoint.
- REST
- A common style of web API using HTTP methods and resource addresses.
- Filter operator
- How a filter compares values: eq, ne, lt, lte, gt, gte, in, nin, case-insensitive ieq, icontains, ilike, and null checks.
- Cursor pagination
- Paging with an opaque token that marks where the last page ended; stable even when data changes.
- Parameterised query
- A database query where user input is passed as data, never as code, which prevents SQL injection.
Access and limits
- API key
- A secret that identifies the caller. Feedvault keys are scoped to the product and shown once when created.
- Bearer token
- A key sent in the Authorization header as "Bearer <key>".
- Rate limit
- The maximum number of requests per minute for a key.
- Quota
- The maximum number of requests per month for a key or plan.
- Metering
- Counting usage, such as requests per key per month, to show and enforce quotas.
- Usage alert
- A warning when usage passes a threshold. Feedvault shows these in the app.
- Revocation
- Disabling a key so it no longer works.
HTTP basics
- 200 OK
- The request worked and the response contains the data.
- 400 Bad Request
- Something in the request is wrong, such as an unknown column or operator. The error message says what.
- No valid API key was sent.
- 402 / quota exceeded
- The key or plan has used its monthly allowance. Feedvault answers 402 when a quota is used up.
- 403 Forbidden
- The key is valid but not allowed to do this, for example a key for another product.
- 429 Too Many Requests
- The rate limit was hit. Wait and retry; the response may say how long.
- Header
- Extra information sent with a request or response, such as Authorization.
Responsible data
- Scraping
- Collecting data from websites automatically, often against their terms. Feedvault never scrapes.
- Enrichment
- Adding outside data to your records, such as finding people's details elsewhere. Feedvault does not enrich records with outside personal data.
- Data minimisation
- Keeping only the fields you need. Leave personal fields out of shared datasets unless you have permission.