Index of every page on this site: llms.txt
Unhead
TypeScript
Schema

Dataset Schema

Copy for LLMs
On this page

Schema.org Dataset

Type: defineDataset<T extends Record<string, any>>(input?: Dataset & T)

Describes a research dataset for scientific, academic, or data science purposes.

Useful Links

Google uses Dataset markup for Dataset Search discovery, not as a rich-result feature in Google Search.

Required properties

  • name string
    The name of the dataset. Google requires it in the rendered Dataset markup. If you omit it from defineDataset(), Unhead uses the resolved page title.
  • description string
    A summary describing the dataset. Google requires 50 to 5,000 characters in the rendered Dataset markup. If you omit it from defineDataset(), Unhead uses the resolved page description; make sure that inherited description also meets the Dataset guidelines.

Recommended Properties

  • creator NodeRelations<Identity>
    The person or organization that created the dataset. Set @type or use definePerson() or defineOrganization() when needed.
  • funder NodeRelations<Identity>
    The person or organization that funded the dataset.
  • distribution NodeRelations<DataDownload>
    Information about how to access or download the dataset. Each distribution requires contentUrl; Unhead adds the DataDownload type and resolves relative URLs.
  • temporalCoverage string
    The time period the dataset covers (ISO 8601 format, e.g., "2020-01-01/2024-12-31").
  • spatialCoverage Arrayable<string | Thing>
    The geographic area the dataset covers.
  • keywords Arrayable<string>
    Keywords describing the dataset.
  • license string
    URL or text specifying the dataset's license.

Defaults

  • @type: Dataset
  • @id: ${canonicalUrl}#dataset
  • name: page title from resolved metadata
  • description: resolved page description
  • url: resolved page URL
  • dateModified: resolved page modification date
  • datePublished: resolved page publication date

Examples

Minimal

defineDataset({
  name: 'Global Temperature Data 2000-2024',
  description: 'Daily temperature measurements from weather stations worldwide',
})

Detailed example

defineDataset({
  name: 'Global Temperature Data 2000-2024',
  description: 'Daily temperature readings and anomaly calculations from weather stations worldwide',
  url: 'https://example.com/datasets/global-temp-2000-2024',
  creator: defineOrganization({
    name: 'Climate Research Institute',
    url: 'https://example.com/about',
  }),
  datePublished: new Date(2024, 0, 1),
  dateModified: new Date(2024, 11, 1),
  version: '2.0',
  keywords: ['climate', 'temperature', 'weather', 'global warming'],
  license: 'https://creativecommons.org/licenses/by/4.0/',
  temporalCoverage: '2000-01-01/2024-12-31',
  spatialCoverage: 'Global',
  distribution: {
    '@type': 'DataDownload',
    contentUrl: 'https://example.com/downloads/global-temp-data.csv',
    encodingFormat: 'CSV',
    contentSize: '125 MB',
  },
  variableMeasured: ['temperature', 'humidity', 'pressure'],
  citation: 'Smith, J. et al. (2024). Global Temperature Dataset. Climate Research Institute.',
  isAccessibleForFree: true,
})

Types

export interface DataDownload extends Thing {
  '@type'?: 'DataDownload'
  'contentUrl': string
  'encodingFormat'?: string
  'contentSize'?: string
}

export interface DataCatalog extends Thing {
  '@type'?: 'DataCatalog'
  'name'?: string
  'url'?: string
}

export interface DatasetSimple extends Thing {
  '@type'?: Arrayable<'Dataset'>
  'name': string
  'description': string
  'alternateName'?: Arrayable<string>
  'url'?: string
  'keywords'?: Arrayable<string>
  'creator'?: NodeRelations<Identity>
  'funder'?: NodeRelations<Identity>
  'citation'?: Arrayable<string>
  'license'?: Arrayable<string | Thing>
  'temporalCoverage'?: string
  'spatialCoverage'?: Arrayable<string | Thing>
  'distribution'?: NodeRelations<DataDownload>
  'hasPart'?: NodeRelations<Dataset | string>
  'isPartOf'?: NodeRelations<Dataset | string>
  'variableMeasured'?: Arrayable<string | Thing>
  'measurementTechnique'?: Arrayable<string | Thing>
  'includedInDataCatalog'?: NodeRelation<DataCatalog>
  'isAccessibleForFree'?: boolean
  'datePublished'?: ResolvableDate
  'dateModified'?: ResolvableDate
  'version'?: number | string
  'sameAs'?: Arrayable<string>
  'identifier'?: Arrayable<PropertyValue | string>
}

Related Schemas

Edit this page
Markdown For LLMs
Did this page help you?

Course Schema

Use defineCourse() to add Course structured data with a provider, description, and course details.

DiscussionForumPosting Schema

Add Google discussion forum structured data with defineDiscussionForumPosting(), including authors, comments, media, and interaction counts.