Skip to main content

Application by data type

The nine questions apply to every kind of data an organization publishes. What changes by type is the record schema, the access format, what "meaning" consists of, and the risks. This page gives the mapping. The running example in the chapters uses indicators; the files list on the overview has a record for each of the other types, and the metadata check in recipe 1.1 runs on all of them.

Record schema and standards by type​

The World Bank's metadata schemas cover each type with a JSON Schema that follows the international standard for that type. Using them means a record can move between the organization's catalog, NADA, the Metadata Editor, and the World Bank's own catalogs without translation. Two open-source tools from the World Bank and IHSN work with all of these types: the Metadata Editor for documenting (templates, validation, export to SDMX metadata structures, schema.org, Croissant, and DCAT, publishing to NADA), and NADA for cataloguing (schema.org markup on each page, keyword and semantic search, a REST API, an MCP interface, and managed access to microdata).

TypeWorld Bank schemaBased onAccess formatInterfaceWhat "meaning" consists ofIdentifier
Indicators and time seriestimeseries-schema.json, timeseries-db-schema.jsonSDMX conceptsSDMX-CSV, SDMX-JSON, tidy CSVSDMX REST API, REST with OpenAPI, MCPDefinition, unit, periodicity, code lists, series breaksidno; DOI through DataCite
Survey and administrative microdatamicrodata-schema.jsonDDI CodebookCSV, Stata, SPSS files with a DDI data dictionaryCatalog API (NADA), access-conditioned downloadUniverse, sampling, weights, variables with value labels, questionnaireidno; DOI through DataCite
Geospatial datageospatial-schema.jsonISO 19115/19139GeoPackage, GeoJSON, Shapefile, Cloud Optimized GeoTIFFOGC API Features, WMS/WFS, STAC for imageryCoordinate reference system, extent, resolution, feature catalogue, lineageidno; DOI through DataCite
Documents and publicationsdocument-schema.jsonDublin CorePDF with extracted text; tables and figures extracted as dataCatalog API, full-text searchAbstract, type, data sources cited, structured table of contentsidno; DOI
Statistical tablestable-schema.jsonWorld Bank table schemaCSV with CSV on the Web metadataCatalog APIRows, columns, unit of observation, footnotes, definitionsidno
Scripts and reproducibility packagesscript-schema.jsonWorld Bank script schemaCode and data in a versioned archiveCatalog API, code hostingInputs, outputs, software, stepsidno; DOI
Images and videoimage-schema.json, video-schema.jsonIPTC, Dublin CoreImage and video filesCatalog APICaption, location, date, rightsidno

The nine questions by data type​

QuestionIndicatorsMicrodataGeospatialDocuments
1. FindName, definition, keywords, aliases in the record; schema.org Dataset on the pageTitle, abstract, keywords, and the variable labels, which are what users search forTitle, abstract, keywords, bounding box and topic category; DCAT and schema.org with spatialCoverageTitle, abstract, keywords, and the full text; schema.org Report or ScholarlyArticle
2. RetrieveSDMX or REST API by series, area, periodDownload under the stated access conditions; a data dictionary API for variablesOGC API Features or WFS for vectors, tiles or COG for rasters; a download in an open formatThe PDF, the extracted text, and the tables and figures as data (Data Snapshots)
3. UnderstandDefinition, unit, periodicity, code lists, series breaksUniverse, sampling, weights, variable definitions and value labels, questionnaireCRS, extent, resolution, feature catalogue (attribute definitions), lineageDocument type, data sources cited, structured table of contents
4. AskSearch by meaning over records; answers from the APISearch over variable labels across surveys; answers that name the survey, the variable, and the universeSearch over titles and keywords with a map filter; answers that state the CRS and the editionFull-text search; answers that cite the page
5. TrustSource, release, OBS_STATUS; number check against the APICitation requirement, version, DOI; access conditions stated with the dataEdition and gazette date, lineage, DOIDOI, publication date, bibliographic citation
6. EvaluateKnown-item questions per languageKnown-variable questions ("age of household head") across surveysKnown-layer questions with a place nameKnown-document questions and page-level citation checks
7. Monitor useMentions of series names and acronymsMentions of survey names and acronyms (the main case for mention detection)Mentions of layer names; service request logsCitations and downloads
8. GovernPublic data; low riskDisclosure control before any exposure; access tiers; no microdata to external servicesSensitive locations; resolution limitsEmbargoes; confidential annexes
9. SustainSame for all types: open standards, separable AI layer, versioned profiles and question sets

Metadata check by data type​

The checker selects the schema from the profile's type and validates the record against it, so the same command works for each type. The profiles are starting points for the organization to edit.

python check_metadata.py example_catalog.csv profile_indicator.json
python check_metadata.py example_microdata.json profile_microdata.json
python check_metadata.py example_geospatial.json profile_geospatial.json
python check_metadata.py example_document.json profile_document.json

Nested records in JSON are what NADA and the Metadata Editor export. CSV works for flat types such as indicators; for microdata, geospatial data, and documents, use JSON.

Principal differences between data types​

  • Microdata needs chapter 8 before chapter 2. Disclosure control and access tiers come before any API or agent interface, and microdata never go to an external AI service. The variables are also the main search target: users look for "age of household head" more often than for a survey title, which is what the program's Metadata Augmentation work addresses by grouping variables into themes.
  • Geospatial data carry their meaning in the coordinate reference system, the extent, and the feature catalogue. A layer without a stated CRS is unusable by software, whatever the description says. OGC services are the equivalent of the SDMX API for this type.
  • Documents are where most official statistics are still locked. The data inside them (tables, figures) become retrievable only when extracted and published next to the document, and the data_sources field links a document to the datasets it used, which is what chapter 7 needs.
  • Tables published as files need column definitions and the unit of observation in the record; CSV on the Web carries the column types.