Table of contents

Schema: statistical_data_set

Frontend schema

This schema describes the content item that is returned from the content store.

analytics_identifier
string or null
A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.
base_path
string
A path only. Query string and/or fragment are not allowed.
content_id
string

description
or null

details
object
body
string
The main content provided as HTML rendered from govspeak
change_history
array

emphasised_organisations
array
The content ids of the organisations that should be displayed first in the list of organisations related to the item, these content ids must be present in the item organisation links hash.
first_public_at
string
DEPRECATED. The date the content was first published. Used in details. Will be deprecated in favour of top level first_published_at when publishing API allows it to be edited.
government
object
current
boolean
Is the government that published this document still the current government.
slug
string
Government slug, used for analytics, eg ‘1970-to-1974-conservative-government’.
title
string
Name of the government that first published this document, eg '1970 to 1974 Conservative government’.
political
boolean
If the content is considered political in nature, reflecting views of the government it was published under.
tags
object
additional_topics
array

browse_pages
array

policies
array

primary_topic
array

topics
array

document_type
string

Allowed values: statistical_data_set
email_document_supertype
string
Document supertype grouping intended to power the Whitehall finders and email subscriptions
first_published_at
or null

government_document_supertype
string
Document supertype grouping intended to power the Whitehall finders and email subscriptions
links
object
available_translations
Link type automatically added by Publishing API
child_taxons
Link type automatically added by Publishing API
children
Link type automatically added by Publishing API
document_collections
Link type automatically added by Publishing API
mainstream_browse_pages
Powers the /browse section of the site. These are known as sections in some legacy apps.
meets_user_needs
The user needs this piece of content meets.
ordered_related_items
Related items, can be any page on GOV.UK. Mostly used for mainstream content to power the sidebar. Ordering of the links is determined by the editor in Content Tagger.
ordered_related_items_overrides
Related items, can be any page on GOV.UK. Overrides 'more like this’ automatically generated links in the beta navigation.
organisations
All organisations linked to this content item. This should include lead organisations.
parent
The parent content item.
policies
Link type automatically added by Publishing API
policy_areas
A largely deprecated tag currently only used to power email alerts.
primary_publishing_organisation
The organisation that published the page. Corresponds to the first of the 'Lead organisations’ in Whitehall, and is empty for all other publishing applications.
taxons
Prototype-stage taxonomy label for this content item
topics
Powers the /topic section of the site. These are known as specialist sectors in some legacy apps.
locale
string

Allowed values: ar, az, be, bg, bn, cs, cy, de, dr, el, en, es, es-419, et, fa, fr, he, hi, hu, hy, id, it, ja, ka, ko, lt, lv, ms, pl, ps, pt, ro, ru, si, sk, so, sq, sr, sw, ta, th, tk, tr, uk, ur, uz, vi, zh, zh-hk, zh-tw
navigation_document_supertype
string
Document type grouping powering the new taxonomy-based navigation pages
need_ids
array

phase
string
The service design phase of this content item - https://www.gov.uk/service-manual/phases
Allowed values: alpha, beta, live
public_updated_at
or null

publishing_app
string
The application that published this item.
Allowed values: calculators, calendars, collections-publisher, contacts, content-tagger, design-principles, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, spotlight, static, tariff, travel-advice-publisher, whitehall
publishing_request_id
A unique identifier used to track publishing requests to rendered content
rendering_app
string
The application that renders this item.
Allowed values: calculators, calendars, collections, designprinciples, email-alert-frontend, email-campaign-frontend, feedback, finder-frontend, frontend, government-frontend, info-frontend, licencefinder, manuals-frontend, performanceplatform-big-screen-view, publicapi, rummager, service-manual-frontend, smartanswers, spotlight, static, tariff, whitehall-admin, whitehall-frontend
schema_name
string

Allowed values: statistical_data_set
search_user_need_document_supertype
string
Document supertype grouping core and government documents
title
string

updated_at
string

user_journey_document_supertype
string
Document type grouping powering analytics of user journeys
withdrawn_notice
object
explanation
string

withdrawn_at

View this schema on GitHub

Random example

{
  "analytics_identifier": "purus ac Ut et hendrerit, ultricies risus amet, imperdiet sed egestas. adipiscing turpis ac interdum. morbi dolor nibh fames elit. Suspendisse suscipit lectus in, sit finibus, eu eros. Ut a Duis sagittis vel cursus Aenean molestie nibh. tempor scelerisque. Lorem bibendum. senectus pellentesque at porttitor eu tempor non est. Sed vestibulum. Quisque mauris lorem sem Pellentesque leo libero. Mauris sollicitudin Nam malesuada ac nisl non orci netus dolor molestie volutpat aliquet. et consectetur risus vel tristique ac habitant interdum. tristique Nam",
  "base_path": "/85194059-5b3a-442c-9293-370a2cd06b7d/6afffaf3-649b-43c0-b0fa-043c790bc7bc",
  "content_id": "5deb3cc6-2fbc-49f9-b155-b6f08951e6e5",
  "description": "risus leo et netus eu a interdum. in, scelerisque. ac suscipit morbi Ut Suspendisse habitant sit dolor elit. tristique fames senectus malesuada Nam est. lectus Lorem ac eu vel risus cursus et turpis nibh ultricies at aliquet. ac molestie",
  "details": {
    "body": "ipsum pellentesque nibh Aenean risus eu vestibulum. a dolor lorem vel",
    "emphasised_organisations": [
      "cd5df099-1790-47ab-9c04-d022ab4ecea9",
      "f6adb066-bd6d-4d6f-b242-3075ceac9ff2",
      "1b18495e-02cd-4c2c-a6ef-170034bbb2e6",
      "d2f4d2f6-404e-47c6-acf6-7ff3e5dca0e6",
      "1f71a3f0-91f2-4410-b3da-c45e31e8d969",
      "ad33e633-253d-4e4a-bdff-ca550cd8a0d8",
      "0da39845-c664-4218-b774-ac37191f8c90",
      "d841b05a-7a91-4ba3-8b2e-b10483db8ec0",
      "53c7fa05-e440-4a99-a7d7-82d6acbaa48a",
      "49af8866-e6e9-487b-a740-cb3ea3f2f786"
    ],
    "first_public_at": "2017-10-09T18:06:16+00:00",
    "government": {
      "current": true,
      "slug": "tristique turpis sit vestibulum. lorem sollicitudin in, senectus et interdum. interdum. Aenean Pellentesque malesuada eros. mauris risus ultricies ac tristique sagittis egestas. tempor et Mauris sed vel leo purus porttitor",
      "title": "massa ac porttitor Nam tempor et adipiscing aliquet. Suspendisse imperdiet risus eu in, volutpat cursus et purus hendrerit, turpis morbi vestibulum. interdum. tristique molestie Duis vel bibendum. tristique sed non sem ipsum egestas. Pellentesque mauris lectus Mauris orci a interdum. habitant Ut senectus fames dolor consectetur sagittis lorem Nam nibh. Sed nisl netus dolor at elit. molestie pellentesque malesuada sit Aenean eros. nibh ultricies est. ac Lorem finibus, vel suscipit Quisque leo libero. non amet, Ut sollicitudin eu scelerisque. tempor ac ac risus"
    },
    "political": true
  },
  "document_type": "statistical_data_set",
  "government_document_supertype": "Nam non morbi tempor malesuada est. molestie Duis turpis tempor Nam ipsum interdum. purus eros. amet, et cursus imperdiet sed sem adipiscing lorem netus nisl risus massa finibus, mauris libero. nibh. tristique volutpat sit porttitor Aenean molestie orci leo dolor ac hendrerit, risus a vel in, Pellentesque sollicitudin eu ac bibendum. Quisque ac elit. pellentesque Ut egestas. at suscipit fames consectetur habitant ac Sed ultricies nibh non Lorem lectus vestibulum. aliquet. interdum. senectus scelerisque. et vel Suspendisse sagittis dolor eu tristique Mauris Ut",
  "links": {
    "mainstream_browse_pages": [
      {
        "api_path": "/7cb63c41-48e5-42dc-a531-f6d1fc095a6e",
        "api_url": "http://example.com/5be706db-fd1e-4e71-876f-8b144c962396/a2bf3059-3892-4dca-9a58-7ef5fe610589#190f94807917b1f4bc49ed64df8bbdbe",
        "base_path": "/b6f13afd-8e03-4939-bd7a-67e438576936/b86086fe-0f12-421b-9237-454de76968c2/9b0fae62-4054-4053-9173-b4e759c97866",
        "content_id": "003a241c-cd85-4b96-a466-d9863325d9e7",
        "document_type": "interdum. risus senectus eros. egestas. ac massa consectetur malesuada amet, Nam non a hendrerit, ac eu interdum. in,",
        "locale": "es-419",
        "schema_name": "imperdiet molestie purus volutpat suscipit amet, bibendum. tristique egestas. Lorem eu Quisque in, est. ac habitant Mauris hendrerit, et ultricies malesuada morbi leo risus tristique turpis scelerisque. risus sit massa vel netus eros. elit. a eu non porttitor ac dolor molestie Ut Ut Duis tempor ac aliquet. nibh vestibulum. finibus, libero. tempor vel consectetur pellentesque et nisl interdum. Nam Sed Aenean Nam sollicitudin lorem nibh. fames Pellentesque sem interdum. adipiscing cursus dolor mauris Suspendisse sagittis ipsum non lectus at sed orci ac senectus",
        "title": ""
      },
      {
        "api_url": "http://example.com/b3b5f6cd-9657-452b-b0c3-af0efa0df584/174a61b2-8b70-439c-85b7-8b74ceb0450d#cf39ec4443f056e3a5639c2bf498e7ba",
        "base_path": "/37a0f477-e47a-45fc-ad9d-2f75ecdcc25b/19a3860c-e9cd-4069-aa4b-65304c9a4979/30f48a4b-a126-4e68-82a2-d469f7d2f0ad/f143a974-3d67-46b1-9136-2d9481039cfa",
        "content_id": "d8a8c244-bfff-44c3-b23c-94c03ff7fdf3",
        "document_type": "cursus vestibulum. risus non est. interdum. nisl Ut at purus ac Quisque et pellentesque molestie lorem malesuada habitant libero. risus tristique sed hendrerit, bibendum. fames eu finibus,",
        "links": {
        },
        "locale": "ro",
        "public_updated_at": "2017-10-06T12:58:56+00:00",
        "title": "leo tristique ac Mauris Ut consectetur Nam scelerisque. ac ipsum malesuada ultricies lectus orci amet, vel Quisque adipiscing ac vel interdum. at vestibulum. Lorem habitant",
        "web_url": "http://example.com/4a9cc9e9-7cae-4da6-ba4d-c766c73e6122/5de5f73e-e88c-4f9f-be9b-e9e96dd82753/0c6322e6-46fd-4b64-9506-23d32b3f1baf#3dd40e4971429b4d67f596dd08a3b669"
      },
      {
        "analytics_identifier": "volutpat ultricies vel Mauris dolor non netus mauris sollicitudin molestie Ut senectus ipsum non malesuada lectus eros. finibus, Ut molestie orci ac bibendum. amet, consectetur habitant turpis aliquet. Lorem suscipit",
        "api_url": "http://example.com/912167d4-d03f-4fc4-8c87-d2f17b5fe835/231da1c3-e0b6-468f-a6ce-adc16fb5cca6#0adf6d277241242811e58bc317076cbe",
        "base_path": "/13da1f7a-3c57-47c4-b3f0-ed1fa9d7a75f/0e9aee5f-631c-4830-9021-0e4d4cd5f2ac/b68462ea-6943-446c-99ed-043dd2c2b168/2e165187-7cbb-4053-884b-70a328a8bbeb/b039139e-87ca-47a0-8add-a083284d184f",
        "content_id": "3b839192-3aed-4884-8f94-424fba0aed38",
        "locale": "bg",
        "public_updated_at": "2017-12-28T16:13:46+00:00",
        "schema_name": "vel cursus scelerisque. in, leo Nam elit. suscipit molestie risus tempor ipsum senectus sit vestibulum. lorem bibendum. amet, consectetur volutpat risus dolor sed sollicitudin malesuada Sed Lorem et sagittis orci libero. vel eros. finibus, molestie interdum. mauris ac egestas. Suspendisse est. pellentesque nibh. dolor tristique Ut a ultricies fames hendrerit, at Pellentesque eu Ut Duis ac purus porttitor ac nibh non tristique Quisque interdum. massa sem adipiscing",
        "title": "fames mauris malesuada in, libero. hendrerit, finibus, lectus porttitor at Pellentesque vestibulum. ultricies morbi sollicitudin elit. ac dolor sagittis consectetur orci ipsum purus Suspendisse nibh. nibh bibendum. Quisque Lorem interdum. cursus Nam tempor aliquet. leo adipiscing Sed eu sem non egestas. molestie lorem nisl scelerisque. sed massa et Ut eros. tempor vel suscipit non Mauris turpis risus tristique Nam habitant ac interdum. molestie et imperdiet netus",
        "web_url": "http://example.com/522a3d59-b8cf-4a34-a732-593e049e2524/49cbba1f-4571-4e3a-a91b-4c465f47aa89/4f35976b-84df-4ff5-9b1b-e087217afe09#158ea0eeb5b87001015d020979078087"
      },
      {
        "analytics_identifier": "dolor vel fames libero. habitant",
        "base_path": "/acd758ae-e100-448c-85a6-5bdb927b3cf6/1a95a30d-0960-4ebf-aae8-8c3414539fac/96361e79-8eae-4c35-b2a2-17ae3c1620ec/c7cf60ce-fb77-446a-9646-9b818b27a3f4",
        "content_id": "16b81dac-2557-4584-b7ee-0830811fc280",
        "links": {
        },
        "locale": "hu",
        "schema_name": "Nam Sed sem turpis nisl nibh lorem malesuada amet, habitant tempor suscipit fames nibh. eu scelerisque. tristique risus interdum. ac et eu leo dolor Quisque sed tristique Nam Pellentesque aliquet. netus elit. a dolor vel senectus non est. finibus, ac ipsum orci Aenean porttitor lectus Mauris bibendum.",
        "title": "molestie senectus aliquet. netus elit. dolor tempor risus non eros. egestas. molestie tristique malesuada habitant ac Aenean Nam ac cursus volutpat fames mauris in, imperdiet at consectetur nibh. vel Ut amet, orci Nam ipsum Ut sed risus bibendum. sagittis Pellentesque turpis scelerisque. ultricies eu dolor leo porttitor hendrerit, Mauris a pellentesque Quisque nibh massa adipiscing ac lorem morbi sem eu Duis interdum. tristique tempor interdum. libero. Sed et lectus purus Lorem suscipit sollicitudin",
        "web_url": "http://example.com/2e598093-7273-4264-a5ac-d0637692d5af/3f333871-b117-43b1-b962-36cf2711a268#2b70b96b73a74b99e4858826a392c2fb"
      },
      {
        "api_path": "/2d812b0e-8c6d-4674-aef1-42d6d037cd23/529d12e8-615b-43ef-b99c-3c152447f70b",
        "base_path": "/f54ab5b6-e149-489d-b4b6-126fa4a5245e/a788825d-73bc-49e7-8e01-e98621d4a87d/17962446-816d-4798-85a0-7b2367ff85cc",
        "content_id": "1c0b6641-6b7c-41b7-a299-4b4630323117",
        "locale": "dr",
        "public_updated_at": null,
        "schema_name": "bibendum. ac libero. non risus egestas. Suspendisse vel fames sagittis senectus consectetur sem et ac volutpat nisl eros. nibh lectus mauris ipsum Pellentesque et malesuada tempor Sed interdum. ac interdum. pellentesque adipiscing ac Ut suscipit eu ultricies amet, netus purus Nam aliquet. sollicitudin dolor at molestie vel leo elit.",
        "title": "Ut ac consectetur ac sollicitudin morbi Sed porttitor volutpat adipiscing Aenean sagittis imperdiet Quisque risus Mauris fames Nam malesuada orci molestie molestie amet, purus tempor mauris dolor hendrerit, egestas. bibendum. nisl suscipit sit interdum. turpis Nam Lorem elit. ultricies risus habitant tristique",
        "web_url": "http://example.com/792f77ee-e90b-41d0-b8ec-f7a4d9ed6e99/db5eaf22-851e-4448-a30a-d23924b0a07b/03733fb5-01d0-412e-bc34-44dc2b4790eb/cbd8bb1b-4bef-477c-8150-2d5d3133f5e2/1da06f49-cf34-4e78-a2b0-6171d755a090#0aa982dd089911e574fc906449170d0d"
      },
      {
        "analytics_identifier": "est. netus nisl adipiscing dolor Lorem libero. eros. vel aliquet. in, habitant vestibulum. sem bibendum. ac lorem egestas. senectus tempor Mauris Nam eu molestie imperdiet ac fames et tristique molestie risus finibus, Quisque ultricies Duis sit a Ut purus non tempor dolor volutpat sagittis lectus Pellentesque Nam hendrerit, ac nibh elit. Ut amet, eu nibh. Sed massa sollicitudin porttitor mauris scelerisque. Aenean tristique vel at morbi Suspendisse consectetur et malesuada ac suscipit interdum. turpis risus leo non interdum. ipsum orci pellentesque cursus sed",
        "api_url": "http://example.com/e15c0494-61c7-4df7-b076-e953e8109b1a/fdd37c1c-6d4d-4396-8121-000327ec4c86#df483464368355f2166fc205e0792f4e",
        "base_path": "/06e0db89-def3-49c0-9653-4dab19f5eaf5/f5afb580-1c66-4966-9572-a4811cd43dde/0a372a1b-4d18-4862-b808-bea8d95aebcc/63fce923-7f69-4fcf-8fb8-8ec7fb032a72/09ed5636-e3cf-49ae-8709-d03a2f6fe87d",
        "content_id": "7a6b1be2-92bc-4ef0-a787-07046290084e",
        "document_type": "tempor interdum. leo tristique libero. volutpat senectus sit sed tristique Aenean ac at et aliquet. Ut Duis molestie netus Mauris est. ac hendrerit, et tempor Nam dolor ipsum Lorem ac consectetur non amet, interdum. nibh. malesuada sagittis habitant massa bibendum. pellentesque purus Ut imperdiet vel sollicitudin sem vestibulum. nisl finibus, Sed Suspendisse molestie scelerisque. risus morbi dolor",
        "locale": "es",
        "public_updated_at": null,
        "title": "Aenean adipiscing orci eu sit vel nisl malesuada molestie massa amet, senectus Ut nibh et vestibulum. interdum. libero. Nam ac Lorem turpis dolor scelerisque. sollicitudin eu tempor hendrerit, et Suspendisse in, cursus non est. ipsum risus vel netus Quisque sed suscipit Nam pellentesque habitant Pellentesque bibendum. non ac finibus, tristique tempor Sed ac a morbi risus",
        "web_url": "http://example.com/14c074ee-e058-4847-8fcc-5b4e4bc61a02/b726cb57-1e25-41ac-a088-d9ee94b22250#8246850802d9013d8f917e1b973603dc"
      },
      {
        "base_path": "/89653f26-4640-4a97-b30c-bd665d825d6c/9ac5b909-29b6-4c9d-8b98-3b224718d1a1",
        "content_id": "b6932246-0726-40fd-8676-22fb9024c11b",
        "locale": "ja",
        "schema_name": "dolor morbi ac in, amet, risus dolor Nam Sed lectus vel Mauris senectus ipsum Suspendisse fames at tempor aliquet. adipiscing sollicitudin et et Lorem imperdiet orci a pellentesque eu Nam leo purus massa nibh molestie netus eros. sem vestibulum. mauris finibus, Pellentesque tempor Aenean vel suscipit nisl turpis elit. porttitor habitant hendrerit, interdum. egestas. ac sagittis lorem tristique libero. eu Ut bibendum.",
        "title": "tristique tempor a est. interdum. molestie sit sollicitudin risus cursus malesuada nisl"
      },
      {
        "api_url": "http://example.com/46ac9ba8-d71f-41a9-b599-d01cca1802a5/13b326c7-2e04-4a0a-9e21-8cf3325f97a3/5038ba97-b5a5-4d6c-9cb2-227bf7c516af/f758554c-73e7-4ae1-b5b3-b142e029234d/b74d1c43-a62d-4396-962c-4875e5f3d7df#ca9b9377ee41a986d5af3562b4a4529d",
        "base_path": "/3de5f0a4-f0eb-4724-a37f-1b5485525713/9df1c4b5-927d-4694-8d63-d94a7764fbcf/c84685e6-504e-42e8-9b9f-c93c08bb7669/06881ee8-fe67-4354-94fc-51a472119877",
        "content_id": "f0d25121-581a-4eec-ac7c-5c1899b70dc6",
        "links": {
        },
        "locale": "ar",
        "title": "orci eu non Aenean ac et hendrerit, massa cursus sem et purus sagittis sed eu at ac imperdiet Ut egestas. suscipit Suspendisse Nam tristique aliquet. turpis eros. dolor nisl finibus, malesuada risus est. pellentesque vestibulum. Nam sollicitudin ultricies in, non libero. sit a scelerisque. lorem ac ac Sed netus interdum. tristique tempor lectus fames Pellentesque vel nibh. molestie tempor molestie adipiscing Duis vel morbi interdum. volutpat Mauris porttitor Quisque dolor Ut ipsum leo bibendum. consectetur habitant amet, Lorem elit. mauris senectus nibh risus",
        "web_url": "http://example.com/e2f475dc-fc66-417c-afdb-4d50d4d7e51a#6e7b836077ff8f3aae0f231f2cbbf79d"
      }
    ],
    "meets_user_needs": [
      {
        "analytics_identifier": "Nam a tempor suscipit cursus non interdum. pellentesque Duis tempor et Suspendisse Ut in, libero. mauris leo sagittis turpis malesuada lectus risus Lorem non risus sollicitudin adipiscing purus est. at morbi bibendum. vel dolor nibh Sed netus vel tristique eu tristique porttitor imperdiet Aenean Quisque scelerisque. molestie sed fames sit aliquet. orci sem consectetur ultricies molestie egestas. et senectus Ut ac interdum. ac volutpat amet, hendrerit, habitant Nam finibus, ac ipsum dolor nisl Mauris eros. Pellentesque vestibulum. eu lorem nibh. massa ac elit.",
        "api_path": "/941ebeb3-6faf-4686-bf9d-75b3ed82982c",
        "api_url": "http://example.com/b6fa06be-756e-4f1e-917e-34153f35f5f0#fa663cdd6d9709791369f3b3799cc87c",
        "base_path": "/4340842b-88a4-45e3-bf7f-bfce691795c7/efe875b7-8b26-49b7-bda5-4396c7046b47/ae3d917c-b206-4bb6-ab76-2e0ee6772fec/07cbe4ab-250a-4fc5-89b7-c815f44c317f",
        "content_id": "cc48f5c5-efda-454d-91fd-b0eae9a44224",
        "document_type": "malesuada ac Sed Ut tristique at",
        "locale": "sw",
        "schema_name": "molestie nibh finibus, Sed cursus lorem sed non non imperdiet purus adipiscing Ut Nam bibendum. porttitor risus ac elit. eu at aliquet. ac et eros. fames interdum. mauris a ultricies vestibulum. risus nisl malesuada et habitant Nam libero. Lorem senectus interdum. ac ac lectus Aenean",
        "title": "aliquet. Sed Nam risus elit. egestas. libero. Aenean hendrerit, finibus, Suspendisse non Ut Ut",
        "web_url": "http://example.com/715bea3e-b008-4cd7-bcd2-cd3c5f014012/d6d29927-9e27-47f5-941b-36cf528b57ec#8de40b048141b43d49ae08a9c608f668"
      },
      {
        "api_path": "/7cf268df-d9d3-4ae1-a3aa-71363570709d/eff28b12-51dd-4cc6-9848-e26ac56b4854/1e4cf843-0405-4670-b256-e89f09ef2f26/7a55b38c-3169-4f45-ac78-d599ad3f8b3f",
        "base_path": "/f41dd9b8-e905-400c-8c3f-c0aee68d39bc/c10f977f-0209-43e8-8fcc-0bad67353de9",
        "content_id": "46660082-9963-4ad5-a40e-8f09b4227f94",
        "document_type": "habitant Suspendisse ac suscipit nibh molestie mauris sed ac massa tempor et est. et ac porttitor ac tempor nibh. vestibulum. consectetur pellentesque Duis risus interdum. non eu molestie in, senectus libero. finibus, eros. orci malesuada Ut Quisque aliquet. dolor morbi Lorem sollicitudin nisl",
        "locale": "sr",
        "schema_name": "ac Lorem tristique eu vel sagittis et volutpat ac ac est. Duis aliquet. Sed netus elit. morbi ultricies Aenean lorem vestibulum. a Pellentesque ac finibus, non sollicitudin Mauris pellentesque at massa bibendum. sit turpis malesuada amet, eu interdum. tempor suscipit orci leo interdum. libero. habitant in,",
        "title": "nibh. sed risus lectus ipsum suscipit massa in, habitant sagittis nisl Lorem vel finibus, molestie cursus Duis eu non tristique et Ut Sed est. tempor risus adipiscing tristique amet, senectus dolor Mauris Nam Nam hendrerit, interdum. leo purus Pellentesque et sem mauris egestas. Ut Suspendisse dolor nibh ac Quisque consectetur interdum. volutpat vestibulum. morbi at malesuada molestie tempor netus vel libero. a turpis ac elit. lorem scelerisque. fames Aenean ultricies orci ac non aliquet. pellentesque ac eu imperdiet porttitor sit bibendum. sollicitudin"
      }
    ],
    "policies": [
      {
        "analytics_identifier": "Nam sed Pellentesque imperdiet volutpat mauris suscipit hendrerit, fames vel et malesuada Ut at libero. sollicitudin ac vel nibh aliquet. adipiscing ultricies amet, netus nibh. in, porttitor non dolor pellentesque ac eu consectetur morbi molestie sit interdum. sagittis risus orci et a tristique Aenean Nam elit. finibus, Ut turpis leo vestibulum. Duis nisl purus ipsum habitant eros. non Sed molestie cursus scelerisque. egestas. sem bibendum. Mauris tempor Lorem tempor risus lorem est. Suspendisse ac massa interdum. dolor tristique ac senectus Quisque lectus eu",
        "api_url": "http://example.com/41e045b9-7e3d-42c8-8b54-4367e0ac537d/4fb7d372-ed30-46fd-9597-3c7b85d685b9#7617785e02ce435d2cd283d9a97c2b95",
        "base_path": "/208e9b01-f2e1-4803-8041-4ae515fe9a84/add89277-1d6e-4450-8bda-281965673a11/8c547ad6-bb8c-4733-a0cb-258f6d1b70ca",
        "content_id": "ea086fb4-6746-459c-8186-df0031555cfc",
        "links": {
        },
        "locale": "vi",
        "schema_name": "ac at",
        "title": "vel Ut sed eros. fames at bibendum. amet, tempor ac purus"
      },
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/a9b67a41-ddb8-420d-bdb2-a7e38fdaebb5/526f842f-7a3e-496e-8ad6-3cdd3824bb06/66c6860c-efd5-4e83-bff8-a9fc4d516caf/2a14595f-2b1b-40f0-aa04-f1c5c6647385#c5c2156f67318e9668b0b6df5ace8f38",
        "base_path": "/67f1d4a2-b42f-46bc-a812-610a7c1bc4ee/8471bdd8-3c31-41fe-9f1d-ce5ec18026e2",
        "content_id": "40488650-f87f-459d-94cb-497ea152ae90",
        "document_type": "Mauris sagittis sem finibus, tristique imperdiet purus non massa molestie ac elit. habitant lectus et est. vel cursus dolor lorem ultricies adipiscing amet, dolor pellentesque Ut vel interdum. eros. at tempor a Nam bibendum. interdum. ac nibh. morbi volutpat non orci risus sit nibh porttitor mauris hendrerit, ipsum Sed et ac egestas. turpis Suspendisse Lorem ac malesuada sollicitudin tempor Pellentesque Duis eu risus vestibulum. leo nisl Aenean aliquet. Quisque in, senectus eu sed consectetur Nam tristique suscipit libero.",
        "links": {
        },
        "locale": "et",
        "public_updated_at": "2017-12-04T01:19:52+00:00",
        "title": "nibh tempor consectetur interdum. lorem dolor Aenean dolor bibendum. purus amet, elit. Ut in, hendrerit, eu scelerisque. risus ac turpis finibus, senectus Sed fames massa a vel orci vel sagittis pellentesque et leo porttitor Duis eu volutpat Nam cursus tempor Lorem lectus risus mauris sollicitudin non ac non adipiscing aliquet. est. nisl et Suspendisse Nam molestie habitant ac ipsum tristique Pellentesque suscipit sit nibh. eros. Ut egestas. sed ultricies Mauris malesuada imperdiet vestibulum. morbi libero. ac",
        "web_url": "http://example.com/5054b48c-714e-4924-860f-06b8fbed4d91/43274416-0c4a-40f7-88f7-4222943fef87/2ffbcaf0-3557-4cfa-a449-c87e5bd06c03/145fd8a8-ca3d-4e9e-a4e8-84b974a6a818/83afaaf6-fd57-481c-a154-e9a8bb917ddc#8c5836d500188d13f254c76a31d9936a"
      },
      {
        "base_path": "/7f43248b-03f4-4315-9951-cc03789d0f16/a5e71dfb-a7ce-43fe-8b9a-806f8ad5d1c2/01f5199e-2703-45ef-823e-0e1aebbc60d8/c5abf715-5fde-442e-a484-1149b00d5472",
        "content_id": "57150934-a3b7-48f2-ba7d-23e9a6e43b77",
        "document_type": "vel eu Duis finibus, Mauris Aenean libero. volutpat netus",
        "locale": "id",
        "title": "ac vel Pellentesque vestibulum. tristique imperdiet senectus ac a molestie volutpat est. ac ac vel cursus purus fames netus risus elit. sem Duis Ut Mauris bibendum. at Quisque scelerisque. ultricies risus sagittis pellentesque molestie hendrerit, Nam egestas. aliquet. non libero. in, orci massa adipiscing mauris nibh ipsum porttitor malesuada Suspendisse nibh. interdum. Lorem nisl amet, sit Nam Aenean et dolor dolor lorem eros. turpis morbi eu leo lectus non finibus, Ut tempor suscipit interdum. sed tristique consectetur habitant"
      },
      {
        "api_path": "/9eded7ac-53e7-47e2-8f6c-b84336f0c20f/5ac12d39-7cde-4648-8d18-7575b28dfdc3/b8c2026a-4263-47a0-92a7-305723ba5012",
        "api_url": "http://example.com/d75f16c4-9b70-4e2e-9302-a7ef790af8e0/a6526f53-a277-43f2-bdf0-cd14260c6d85/2a01b460-ca32-486a-a4ee-5fc7d78ad951/68d240aa-5169-4af8-9f82-3a81ec436209#0c63bcdb2e2a326afebe341daa4a756d",
        "base_path": "/118dc30b-3d02-474f-9ce9-4edcb67ac635",
        "content_id": "fc97013e-b20f-4643-964d-b696e0dc76d4",
        "document_type": "non libero. malesuada at ac sed vel",
        "locale": "es-419",
        "public_updated_at": null,
        "title": "tristique finibus, Quisque porttitor suscipit orci habitant aliquet. et Ut sit Pellentesque risus morbi malesuada purus pellentesque imperdiet cursus tempor dolor non Lorem leo Suspendisse ac nibh Sed libero. sollicitudin risus elit. vestibulum. eros. ipsum at sagittis netus tristique vel"
      },
      {
        "analytics_identifier": "lectus ac massa risus fames senectus turpis orci ac Sed ultricies sollicitudin vel mauris elit. Lorem ipsum a scelerisque. tempor",
        "base_path": "/9a47d00a-c1b5-48bf-85cc-1e050d8fcdbd/e674d91e-54d7-4f50-b67c-ba7686bf6127",
        "content_id": "a9659d98-4098-4671-b786-9d4f76c2b92c",
        "locale": "es",
        "public_updated_at": "2017-10-23T14:21:59+00:00",
        "title": "Nam adipiscing amet, ac et sed vel cursus lorem Ut sem sollicitudin senectus hendrerit, Lorem nibh. est."
      }
    ]
  },
  "locale": "dr",
  "navigation_document_supertype": "molestie mauris finibus, Mauris dolor volutpat dolor at tristique Pellentesque vestibulum. ipsum tempor fames Nam cursus sed leo Ut sit habitant ac in, a morbi sollicitudin egestas. Ut aliquet. ultricies Sed eros. nisl nibh. Quisque Nam lorem bibendum. hendrerit, massa orci risus interdum. non nibh Suspendisse amet, pellentesque vel ac et elit. non netus ac malesuada eu lectus consectetur tristique sem imperdiet scelerisque. suscipit sagittis Aenean ac Duis senectus Lorem risus tempor libero. adipiscing porttitor est. molestie et purus interdum. eu turpis vel",
  "need_ids": [
    "turpis libero. pellentesque elit. suscipit sem vel risus netus ac lectus a hendrerit, amet, Nam fames et et mauris aliquet. eros. egestas. dolor volutpat ac massa",
    "ac scelerisque. leo hendrerit, Lorem aliquet. mauris sed fames eu lorem Mauris purus ac cursus tristique finibus, at Ut vestibulum. habitant massa molestie Nam nibh. tempor eros. ac sagittis Quisque dolor non suscipit Ut morbi libero. pellentesque Suspendisse ac turpis malesuada sem ultricies et Nam Duis et sollicitudin egestas. volutpat Aenean est. tristique tempor interdum. nibh senectus eu Pellentesque consectetur nisl bibendum. risus risus dolor Sed sit netus imperdiet amet, non porttitor in, interdum. orci",
    "turpis sit Ut lorem habitant interdum. dolor a ac ipsum pellentesque imperdiet Nam tempor massa ac risus adipiscing Lorem ac Aenean purus aliquet. molestie non vel interdum. Sed Duis Suspendisse scelerisque. risus sed Pellentesque consectetur at nibh. Mauris tristique egestas. eros. ultricies vel bibendum. dolor in, finibus, nibh suscipit leo et porttitor tristique hendrerit, sollicitudin nisl Ut Nam volutpat Quisque orci cursus",
    "non fames in, dolor libero. molestie bibendum. tempor eu nibh vestibulum. a vel scelerisque. nibh. purus vel ac Lorem tristique Mauris adipiscing nisl dolor interdum. interdum. tempor at Duis ultricies risus finibus, sem ac amet, aliquet. sollicitudin sit orci",
    "dolor Suspendisse nisl dolor eros. nibh",
    "porttitor dolor purus molestie Pellentesque interdum. Ut et cursus turpis Ut ac Lorem Aenean et tempor senectus tristique risus sit eros. risus elit. ac libero. massa mauris ipsum habitant sagittis Nam sem nibh. Sed finibus, hendrerit, imperdiet interdum. ac lectus ac lorem est. dolor non",
    "lectus Lorem Mauris non mauris Ut finibus, tristique pellentesque ipsum elit. habitant libero. Suspendisse sem interdum.",
    "vestibulum. non non Sed et sit Lorem lectus interdum.",
    "ac bibendum. scelerisque. tempor eu porttitor habitant volutpat interdum. leo tristique elit. risus sit eu finibus, sem lorem vel tempor purus suscipit dolor Pellentesque ac morbi et Nam imperdiet vel Lorem sollicitudin molestie Ut consectetur Sed molestie at senectus ac ac nibh orci Duis tristique Quisque hendrerit, aliquet. libero. Ut amet, ultricies interdum. risus massa sed lectus in, mauris netus dolor vestibulum. nibh. turpis"
  ],
  "phase": "live",
  "public_updated_at": "2018-01-14T01:27:47+00:00",
  "publishing_request_id": "Ut mauris ac vestibulum. netus consectetur ac lectus pellentesque nibh. ipsum vel porttitor vel Ut Nam malesuada finibus, adipiscing nibh at aliquet. sed sagittis est. risus non ultricies molestie eros. sem molestie hendrerit, Lorem in, morbi et bibendum. ac amet, et turpis orci elit. cursus imperdiet libero. sit nisl leo habitant tristique dolor dolor purus Quisque Aenean volutpat",
  "schema_name": "statistical_data_set",
  "search_user_need_document_supertype": "est. Sed dolor eu turpis sagittis dolor suscipit amet, purus Aenean adipiscing tempor Nam cursus sem vel consectetur sit eu",
  "title": "vel consectetur porttitor Duis purus sit nisl at Mauris massa risus imperdiet dolor Ut cursus lorem senectus dolor sagittis tempor bibendum. sed interdum. et molestie tristique interdum. ac Ut scelerisque. Nam vestibulum. sem Aenean adipiscing vel leo pellentesque sollicitudin eros. habitant Quisque ac elit. aliquet. Nam nibh. ipsum volutpat amet, turpis Pellentesque Suspendisse morbi libero. orci lectus eu ac a tristique et mauris est. hendrerit, netus Sed risus ac ultricies nibh finibus, malesuada Lorem molestie non eu in, suscipit non",
  "updated_at": "2017-12-07T12:42:58+00:00",
  "withdrawn_notice": {
    "explanation": "cursus interdum. risus a egestas. leo Mauris scelerisque. ac suscipit hendrerit, tempor vel dolor est. ac turpis morbi tristique consectetur molestie sem orci mauris eros. Ut tristique eu ac vel dolor massa porttitor fames ac non Sed Quisque amet, at lectus vestibulum. ultricies sit ipsum molestie aliquet.",
    "withdrawn_at": "2017-12-13T13:47:37+00:00"
  }
}

Publisher content schema

This is what publisher apps should send to the publishing-api in This is what a publishing application sends to the publishing-api in a put_content call.

Attributes

access_limited
object
auth_bypass_ids
A list of ids that will allow access to this item for non-authenticated users
users
array

analytics_identifier
string or null
A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.
base_path
string
A path only. Query string and/or fragment are not allowed.
change_note
["null", "string"]

description
or null

details
object
body
string
The main content provided as HTML rendered from govspeak
change_history
array

emphasised_organisations
array
The content ids of the organisations that should be displayed first in the list of organisations related to the item, these content ids must be present in the item organisation links hash.
first_public_at
string
DEPRECATED. The date the content was first published. Used in details. Will be deprecated in favour of top level first_published_at when publishing API allows it to be edited.
government
object
current
boolean
Is the government that published this document still the current government.
slug
string
Government slug, used for analytics, eg '1970-to-1974-conservative-government’.
title
string
Name of the government that first published this document, eg '1970 to 1974 Conservative government’.
political
boolean
If the content is considered political in nature, reflecting views of the government it was published under.
tags
object
additional_topics
array

browse_pages
array

policies
array

primary_topic
array

topics
array

document_type
string

Allowed values: statistical_data_set
first_published_at
string
The date the content was first published. Automatically determined by the publishing-api, unless overridden by the publishing application.
last_edited_at
string
Last time when the content received a major or minor update.
links
object
policy_areas
A largely deprecated tag currently only used to power email alerts.
locale
string

Allowed values: ar, az, be, bg, bn, cs, cy, de, dr, el, en, es, es-419, et, fa, fr, he, hi, hu, hy, id, it, ja, ka, ko, lt, lv, ms, pl, ps, pt, ro, ru, si, sk, so, sq, sr, sw, ta, th, tk, tr, uk, ur, uz, vi, zh, zh-hk, zh-tw
need_ids
array

phase
string
The service design phase of this content item - https://www.gov.uk/service-manual/phases
Allowed values: alpha, beta, live
previous_version
string

public_updated_at
string
When the content was last significantly changed (a major update). Shown to users. Automatically determined by the publishing-api, unless overridden by the publishing application.
publishing_app
string
The application that published this item.
Allowed values: calculators, calendars, collections-publisher, contacts, content-tagger, design-principles, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, spotlight, static, tariff, travel-advice-publisher, whitehall
redirects
array

rendering_app
string
The application that renders this item.
Allowed values: calculators, calendars, collections, designprinciples, email-alert-frontend, email-campaign-frontend, feedback, finder-frontend, frontend, government-frontend, info-frontend, licencefinder, manuals-frontend, performanceplatform-big-screen-view, publicapi, rummager, service-manual-frontend, smartanswers, spotlight, static, tariff, whitehall-admin, whitehall-frontend
routes
array

schema_name
string

Allowed values: statistical_data_set
title
string

update_type

Allowed values: major, minor, republish

View this schema on GitHub

Random example

{
  "access_limited": {
    "auth_bypass_ids": [
      "4173e6f4-743a-4317-81f0-1165a2f69434",
      "e4675d59-e890-4f04-94c6-1878734c4350"
    ]
  },
  "base_path": "/adf6dd75-d486-47ac-bb9a-1f9f7bdc1ad8/bb79fb3c-0803-4da9-8e18-e01bd641add9/1257c16a-1238-4add-bcb2-01b89bebcbd4/f6e87f49-4a01-4a81-b16e-bef09d208b09/bb328117-d4ee-45dd-91d6-945885e0e566",
  "change_note": "risus ac Pellentesque ac non scelerisque. massa risus amet, Nam lorem habitant ultricies egestas. morbi est.",
  "details": {
    "body": "Nam Duis Quisque netus et fames finibus, hendrerit, ac a eu nibh. malesuada sit Ut eros. Sed risus nisl tempor vel est. scelerisque. cursus Lorem et volutpat eu pellentesque Pellentesque egestas. molestie Suspendisse molestie tristique aliquet. interdum. sagittis ac in, sollicitudin vestibulum. non leo interdum. lorem purus ipsum Ut mauris bibendum. massa Mauris tristique morbi porttitor imperdiet libero. sed dolor dolor",
    "first_public_at": "2017-12-26T17:57:05+00:00",
    "government": {
      "current": true,
      "slug": "interdum. Pellentesque est. tristique nisl habitant in, Ut netus dolor lectus ipsum sagittis et risus Lorem Ut aliquet. dolor nibh. at malesuada nibh Nam tempor Aenean leo interdum. sem eros. non scelerisque. sit imperdiet orci risus ac egestas. Sed finibus, senectus massa lorem sollicitudin amet, bibendum. Quisque Suspendisse Mauris ac ac libero. turpis eu non vestibulum. Nam sed Duis fames hendrerit, ultricies pellentesque a vel vel volutpat et tristique porttitor morbi ac consectetur adipiscing cursus suscipit purus tempor eu molestie mauris molestie elit.",
      "title": "Mauris Quisque ac tempor amet, ipsum senectus dolor Ut interdum. et tristique ac egestas. leo at imperdiet bibendum. pellentesque malesuada massa dolor vestibulum. fames finibus, habitant mauris vel elit. Ut consectetur netus adipiscing orci purus Sed tempor vel Pellentesque est. sem sed ultricies eros. ac eu interdum. sagittis Suspendisse turpis molestie Aenean molestie risus in, cursus suscipit aliquet. lectus morbi eu non ac nisl risus a lorem Duis et Nam volutpat"
    },
    "political": false
  },
  "document_type": "statistical_data_set",
  "last_edited_at": "2017-11-16T22:20:37+00:00",
  "locale": "bg",
  "need_ids": [
    "at fames non tristique risus habitant nibh. vel malesuada volutpat ultricies Mauris tempor bibendum. cursus orci senectus dolor scelerisque. ac sed sollicitudin sit molestie suscipit Pellentesque Duis Lorem amet, nisl non in, Nam Ut massa nibh elit. Aenean vel hendrerit, Quisque vestibulum. Nam egestas. eu molestie tempor pellentesque purus a ac netus ac ipsum consectetur et est. sem turpis Suspendisse Ut finibus, eros. tristique adipiscing morbi et porttitor eu dolor libero. interdum. leo risus mauris ac"
  ],
  "public_updated_at": "2017-12-18T13:38:49+00:00",
  "publishing_app": "licencefinder",
  "rendering_app": "finder-frontend",
  "routes": [
    {
      "path": "Nam aliquet. scelerisque. Quisque Ut sagittis interdum. eu egestas. ac fames leo non adipiscing massa Lorem orci Mauris nisl vel eros. ac imperdiet Suspendisse mauris lorem vestibulum. ipsum senectus volutpat sed lectus libero. a habitant interdum. amet, ac risus Sed purus bibendum. pellentesque Aenean cursus nibh. hendrerit, malesuada",
      "type": "prefix"
    },
    {
      "path": "Pellentesque Suspendisse bibendum. non mauris ipsum senectus non Sed fames in, eu nibh Ut egestas. tempor interdum. finibus, nisl nibh. aliquet. sagittis est. leo dolor Duis lectus adipiscing risus Quisque tempor suscipit netus at Mauris sem ultricies turpis orci Nam",
      "type": "exact"
    },
    {
      "path": "ac purus sollicitudin",
      "type": "prefix"
    },
    {
      "path": "fames molestie Quisque malesuada bibendum. adipiscing elit. vel nibh Aenean consectetur Lorem leo Ut nisl tristique mauris eu lorem dolor finibus, scelerisque. suscipit molestie habitant a ac non eu ipsum nibh. sagittis non",
      "type": "exact"
    }
  ],
  "schema_name": "statistical_data_set",
  "title": "tristique Sed molestie vestibulum. fames at Lorem sollicitudin tempor imperdiet elit. volutpat eu non risus tempor nisl nibh Ut risus senectus et libero. interdum. lectus amet, purus ac Suspendisse Duis sed vel hendrerit, est. massa ac habitant"
}

The links for this item. This is what a publishing application sends in a patch_links call.

Attributes

links
object
mainstream_browse_pages
Powers the /browse section of the site. These are known as sections in some legacy apps.
meets_user_needs
The user needs this piece of content meets.
ordered_related_items
Related items, can be any page on GOV.UK. Mostly used for mainstream content to power the sidebar. Ordering of the links is determined by the editor in Content Tagger.
ordered_related_items_overrides
Related items, can be any page on GOV.UK. Overrides 'more like this’ automatically generated links in the beta navigation.
organisations
All organisations linked to this content item. This should include lead organisations.
parent
The parent content item.
policy_areas
A largely deprecated tag currently only used to power email alerts.
primary_publishing_organisation
The organisation that published the page. Corresponds to the first of the 'Lead organisations’ in Whitehall, and is empty for all other publishing applications.
taxons
Prototype-stage taxonomy label for this content item
topics
Powers the /topic section of the site. These are known as specialist sectors in some legacy apps.
previous_version
string

View this schema on GitHub

Random example

{
  "links": {
    "mainstream_browse_pages": [
      "58ab1b2b-7b2c-4671-8965-450adb345e8d",
      "04356185-aa97-4a1c-aa3e-cd760cbcfe71"
    ],
    "ordered_related_items_overrides": [
      "dc67be9b-f002-4269-a01d-af103537bd0a",
      "5456afd8-3599-4f3d-93b4-d9f6a49390d5",
      "c338b7b7-6e0c-4cb9-b7db-ce0989dc5e75",
      "d9002630-5f65-4bc7-b451-db43eca185ff",
      "f59621a0-18d8-42f6-aa13-5af087fce644"
    ],
    "organisations": [
      "bab21b33-3537-4a1a-9f69-71bddcfec859",
      "52e2bd2b-480e-41a2-981e-930cd34aca4f",
      "3f3aeb8c-4c3c-4485-bfb5-1f168c6c78b8",
      "4aa0fed2-5086-414a-8e25-703d941c0941",
      "b975b436-e0f5-420f-9d87-a1589c3155e2",
      "03ac66ca-f1d3-48ed-9173-83ab8b09d2ca"
    ],
    "parent": [
      "178924fe-19cf-4711-a6b2-52917d824975"
    ],
    "policy_areas": [
      "34e07f51-3a6f-49c0-a3c2-828be76caa30",
      "96fbe40c-1f3c-45f7-8052-24775273f2a5",
      "a1ea05f5-edce-420a-ba7a-44f0f075b4e9",
      "4918e7fd-9ef3-4126-a8a1-82d6e9310d4c",
      "45cd72dd-99a7-4c07-9478-45d5ce0e393c",
      "d859e394-8cdd-43c7-98c7-1526e04f59cf"
    ],
    "taxons": [
      "85fa624a-5f3f-4705-a403-ad7cc46c573a",
      "abdd06a7-6efd-4643-9a4e-998b80675cdf",
      "bbba4c9c-eec4-4269-a75f-c698a8669816",
      "479890d6-ce96-47f6-a22a-723f0111bfce",
      "3efe84a1-ed1e-4a73-83e9-128428c7dd29"
    ],
    "topics": [
      "3aeb7f22-ffb6-4b29-9af2-703ed5ac0156",
      "9b04328b-53ca-482e-bd3c-287ce4e6d3e2"
    ]
  }
}