• Register

News API v1.5 - JSON response format

Back to top

List Response - Navigation

This general response type is used for enumerating the available lists of resources, such as feeds, schedules,  packages and galleries when accessing the corresponding base endpoint:

{
   "kind":"feed",
   "title":"Press Association News API Feeds",
   "id":"feeds",
   "updated":"2015-08-11T15:06:46.183Z",
   "totalResults":25,
   "startIndex":1,
   "itemsPerPage":10,
   "items":[
      {
         "kind":"feed",
         "id":"businessFinance",
         "title":"Business and Finance",
         "updated":"2015-08-11T15:06:46.183Z"
      },
      ...     
   ]
}

Navigation list responses use the feed kind, which means that you can expect a title, id and updated timestamp for the resource, and an optional set of OpenSearch data (totalResults, startIndex, itemsPerPage) and optional list of items. Note that for navigation list responses, paging of results is enabled and may be controlled by the offset and limit parameters. The itemsPerPage will be be no more than limit, whilst totalResults will be the total list size.

Each item has the same kind, and comes with an idtitle and updated time. The corresponding item can be visited by appending the id to the list endpoint e.g./v1.5/feeds/businessFinance

Search response

The search response is returned for the /assets and /feeds/{id} endpoints, where an asset search is performed and returned as a found list of assets.

{
    "kind": "feed",
    "title": "Search Results",
    "id": "assets",
    "updated": "2015-08-11T16:22:05.341Z",
    "totalResults": 5296784,
    "startIndex": 1,
    "itemsPerPage": 10,
    "facets": {
    },
    "items": [      
        {
            "kind": "asset",
            "id": "cf38dd86-013d-4721-be3c-c2fcbf2d11c3",
            "story": {
                "id": "4ec88767-6d29-4f77-afea-483ffe3b8675",
                "media": [
                    {
                        "kind": "picture",
                        "id": "2.8077449",
                        "title": "Flooding in UK",
                        "summary": "Forecasters are warning of floods after heavy rain",
                        "credit": "PA WIRE",
                        "renditions": {
                            "thumb": {
                                "width": 127,
                                "height": 84,
                                "size": 4084,
                                "href": "https://news.static.press.net/v2/image/thumbnail/6365469e4e1aefc9d4e76b339ccf4060/2.8077449.jpg"
                            },
                            "preview": {
                                "width": 511,
                                "height": 340,
                                "size": 50670,
                                "href": "https://news.static.press.net/v2/image/preview/0d22236449fe005992fe45fdcd4111cb/2.8077449.jpg"
                            },
                            "full": {
                                "width": 2805,
                                "height": 1866,
                                "size": 1222835,
                                "href": "https://news.static.press.net/v2/image/production/da5a75331589a9bd340ed3d85c387e17/2.8077449.jpg"
                            }
                        }
                    }
                ],
                "meta": {
                    "pictureCount": "1",
                    "videoCount": "0",
                    "curatedSocialAttached": "false"
                }
            },
            "leadNumber": 0,
            "title": "WEATHER Floods",
            "headline": "Floods warning as heavy rain forecast for England and Wales",
            "updated": "2015-08-11T16:17:55.510Z",
            "tags": [
                {
                    "id": "pakeyword:floods",
                    "kind": "keyword",
                    "name": "Floods"
                },
                {
                    "id": "tag:rain",
                    "kind": "simple-tag",
                    "name": "Rain"
                },
                {
                    "id": "tag:floods",
                    "kind": "simple-tag",
                    "name": "Floods"
                },
                {
                    "id": "tag:met-office",
                    "kind": "simple-tag",
                    "name": "Met Office"
                },
                {
                    "id": "patopic:WEATHER",
                    "kind": "wire-topic",
                    "name": "Weather"
                },
                {
                    "id": "pacategory:HHH",
                    "kind": "category",
                    "name": "Home News"
                },
                {
                    "id": "pacategory:PPW",
                    "kind": "category",
                    "name": "Welsh Parliament"
                }
            ],
            "summary": "Forecasters warned of possible flooding later this week as England and Wales are likely to see heavy rainfall.",
            "meta": {
                "pageCount": "1"
            }
        },
  	...
    ]
}

Search responses have a kind of feed, the id is simply 'assets' or the feed id, with title being just 'Search Results' or the feed title. The updated value is the origin time of the search.

The totalResults and itemsPerPage now have different values, indicating that you can page through the set of search results using the limit and offset parameters.

The search response also includes an optional set of facets which can be used to drill down further into the result set. The when facet provides a breakdown of results into commonly-used time bands (if a specific band contains no results then it will be omitted). The tag facet reveals how many results include the (up to) 10 most commonly used tags within the result set, inviting guided navigation by adding an additional ?tag= query parameter to add the relevant filter.

Each story in the items array is a Summary Asset Response.

Package response

The package response is returned for packages, where there is a managed finite set of assets curated by PA editorial teams.

{
   "kind":"package",
   "id":"news-main",
   "title":"Main News",
   "updated":"2015-08-11T15:04:47.036Z",
   "totalResults":10,
   "startIndex":1,
   "itemsPerPage":10,
   "items":[     
      {
         "kind":"asset",
         "id":"0e828b3a-bf64-484d-9437-eb6ea365f39f",
         "story":{
            "id":"7d5b540c-31d8-4c80-a487-424a618218f8",
            "media":[
               {
                  "kind":"picture",
                  "id":"2.23415708",
                  "title":"Labour leadership contest",
                  "summary":"Jeremy Corbyn has nearly doubled his lead in just a week, according to a poll",
                  "credit":"PA WIRE",
                  "renditions":{
                     "thumb":{
                        "width":127,
                        "height":85,
                        "size":2819,
                        "href":"https://news.static.press.net/v2/image/thumbnail/f2d5b44e29b52607a715ccec4a7d7af5/2.23415708.jpg"
                     },
                     "preview":{
                        "width":511,
                        "height":341,
                        "size":21372,
                        "href":"https://news.static.press.net/v2/image/preview/060c8690c85ff657f743b242d56aca30/2.23415708.jpg"
                     },
                     "full":{
                        "width":3500,
                        "height":2334,
                        "size":518399,
                        "href":"https://news.static.press.net/v2/image/production/d9026f6f958ce7ab1e03bb98838d7c54/2.23415708.jpg"
                     }
                  }
               }
            ],
            "meta":{
               "pictureCount":"2",
               "videoCount":"0",
               "curatedSocialAttached":"false"
            }
         },
         "leadNumber":3,
         "title":"POLITICS Labour",
         "headline":"Jeremy Corbyn 'cautious' of Labour victory chance as poll gives him big lead",
         "updated":"2015-08-11T15:04:46.134Z",
         "tags":[
            {
               "id":"pakeyword:labour",
               "kind":"keyword",
               "name":"Labour"
            },
            {
               "id":"tag:labour-leadership",
               "kind":"simple-tag",
               "name":"Labour leadership"
            },
            {
               "id":"tag:jeremy-corbyn",
               "kind":"simple-tag",
               "name":"Jeremy Corbyn"
            },
            {
               "id":"tag:andy-burnham",
               "kind":"simple-tag",
               "name":"Andy Burnham"
            },
            {
               "id":"tag:labour-party",
               "kind":"simple-tag",
               "name":"Labour Party"
            },
            {
               "id":"tag:liz-kendall",
               "kind":"simple-tag",
               "name":"Liz Kendall"
            },
            {
               "id":"tag:alastair-campbell",
               "kind":"simple-tag",
               "name":"Alastair Campbell"
            },
            {
               "id":"tag:yvette-cooper",
               "kind":"simple-tag",
               "name":"Yvette Cooper"
            },
            {
               "id":"tag:iain-duncan-smith",
               "kind":"simple-tag",
               "name":"Iain Duncan Smith"
            },
            {
               "id":"tag:ed-miliband",
               "kind":"simple-tag",
               "name":"Ed Miliband"
            },
            {
               "id":"patopic:POLITICS",
               "kind":"wire-topic",
               "name":"Politics"
            },
            {
               "id":"pacategory:HHH",
               "kind":"category",
               "name":"Home News"
            }
         ],
         "summary":"Jeremy Corbyn is \"cautious\" about his chances of victory in the Labour leadership contest despite an opinion poll giving him a clear lead and the bookmakers installing him as favourite to win.",
         "meta":{
            "pageCount":"3"
         }
      },
      ...  
   ]
}

Package responses have a kind of package, the id is the package id, with a more friendly title. The updated value is the last publish time of the package.

The totalResults and itemsPerPage values will, by default, be equal to the number of items in the package - which are also returned. The offset and limit parameters may be passed to modify this behaviour to return less items.

Each story in the items array is a Summary Asset Response.

Schedule response

The schedule response is returned for schedules, where there is a managed finite set of assets curated by PA editorial teams.

{
    "kind": "schedule",
    "id": "news",
    "title": "News Schedule",
    "updated": "2015-08-11T16:31:14.669Z",
    "totalResults": 31,
    "startIndex": 1,
    "itemsPerPage": 31,
    "items": [
        {
            "kind": "asset",
            "id": "20f3d9b2-a6dc-46b9-a6a8-b3021e06200a",
            "story": {
                "id": "b253ea93-6a56-4db1-86f9-ffba5818d329",
                "media": [
                    {
                        "kind": "picture",
                        "id": "2.23790501",
                        "title": "karen",
                        "summary": "Karen Buckley, 24, was murdered by Alexander Pacteau (Crown Office/PA)",
                        "credit": "Torch One time usage images",
                        "renditions": {
                            "thumb": {
                                "width": 84,
                                "height": 127,
                                "size": 5630,
                                "href": "https://news.static.press.net/v2/image/thumbnail/0214b5b46cb0f9b98cfae0724f2f66d1/2.23790501.jpg"
                            },
                            "preview": {
                                "width": 337,
                                "height": 511,
                                "size": 47969,
                                "href": "https://news.static.press.net/v2/image/preview/e9359c81cde31f4c1b003226ea47f701/2.23790501.jpg"
                            },
                            "full": {
                                "width": 2304,
                                "height": 3492,
                                "size": 752716,
                                "href": "https://news.static.press.net/v2/image/production/d305b981d806bb8d217c3d3457909bf6/2.23790501.jpg"
                            }
                        }
                    }
                ],
                "meta": {
                    "pictureCount": "6",
                    "videoCount": "0",
                    "curatedSocialAttached": "false"
                }
            },
            "leadNumber": 3,
            "title": "COURTS Pacteau",
            "headline": "'Truly evil' Alexander Pacteau admits murder of Karen Buckley",
            "updated": "2015-08-11T16:37:02.650Z",
            "tags": [
                {
                    "id": "pakeyword:pacteau",
                    "kind": "keyword",
                    "name": "Pacteau"
                },
                {
                    "id": "tag:karen-buckley",
                    "kind": "simple-tag",
                    "name": "Karen Buckley"
                },
                {
                    "id": "tag:glasgow",
                    "kind": "simple-tag",
                    "name": "Glasgow"
                },
                {
                    "id": "tag:cork",
                    "kind": "simple-tag",
                    "name": "Cork"
                },
                {
                    "id": "tag:ireland",
                    "kind": "simple-tag",
                    "name": "Ireland"
                },
                {
                    "id": "patopic:COURTS",
                    "kind": "wire-topic",
                    "name": "Courts"
                },
                {
                    "id": "pacategory:SCN",
                    "kind": "category",
                    "name": "Scottish News"
                },
                {
                    "id": "pacategory:HHH",
                    "kind": "category",
                    "name": "Home News"
                },
                {
                    "id": "pacategory:IFN",
                    "kind": "category",
                    "name": "Irish File News"
                }
            ],
            "summary": "The man who murdered Karen Buckley by hitting her at least 12 times with a spanner before hiding her body in a barrel of chemicals has been branded \"truly evil\" by the Irish student's father.",
            "edNote": "Stills and video available",
            "meta": {
                "pageCount": "1"
            }
        },
        ...        
    ]
}

Schedule responses have kind of schedule, the id is the schedule id, with a more friendly title. The updated value is the last publish time of the schedule.

The totalResults and itemsPerPage values will, by default, be equal to the number of items in the schedule - which are all returned. The offset and limit parameters may be passed to modify this behaviour to return less items.

Each story in the items array is a Summary Asset Response.

Summary Asset Response

This short-form representation of an asset is used in all JSON list, search, package and schedule responses.

{
   "kind":"asset",
   "id":"20f3d9b2-a6dc-46b9-a6a8-b3021e06200a",
   "story":{
      "id":"b253ea93-6a56-4db1-86f9-ffba5818d329",
      "media":[
         {
            "kind":"picture",
            "id":"2.23790501",
            "title":"karen",
            "summary":"Karen Buckley, 24, was murdered by Alexander Pacteau (Crown Office/PA)",
            "credit":"Torch One time usage images",
            "renditions":{
               "thumb":{
                  "width":84,
                  "height":127,
                  "size":5630,
                  "href":"https://news.static.press.net/v2/image/thumbnail/0214b5b46cb0f9b98cfae0724f2f66d1/2.23790501.jpg"
               },
               "preview":{
                  "width":337,
                  "height":511,
                  "size":47969,
                  "href":"https://news.static.press.net/v2/image/preview/e9359c81cde31f4c1b003226ea47f701/2.23790501.jpg"
               },
               "full":{
                  "width":2304,
                  "height":3492,
                  "size":752716,
                  "href":"https://news.static.press.net/v2/image/production/d305b981d806bb8d217c3d3457909bf6/2.23790501.jpg"
               }
            }
         }
      ],
      "meta":{
         "pictureCount":"6",
         "videoCount":"0",
         "curatedSocialAttached":"false"
      }
   },
   "leadNumber":3,
   "title":"COURTS Pacteau",
   "headline":"'Truly evil' Alexander Pacteau admits murder of Karen Buckley",
   "updated":"2015-08-11T16:37:02.650Z",
   "tags":[
      {
         "id":"pakeyword:pacteau",
         "kind":"keyword",
         "name":"Pacteau"
      },
      {
         "id":"tag:karen-buckley",
         "kind":"simple-tag",
         "name":"Karen Buckley"
      },
      {
         "id":"tag:glasgow",
         "kind":"simple-tag",
         "name":"Glasgow"
      },
      {
         "id":"tag:cork",
         "kind":"simple-tag",
         "name":"Cork"
      },
      {
         "id":"tag:ireland",
         "kind":"simple-tag",
         "name":"Ireland"
      },
      {
         "id":"patopic:COURTS",
         "kind":"wire-topic",
         "name":"Courts"
      },
      {
         "id":"pacategory:SCN",
         "kind":"category",
         "name":"Scottish News"
      },
      {
         "id":"pacategory:HHH",
         "kind":"category",
         "name":"Home News"
      },
      {
         "id":"pacategory:IFN",
         "kind":"category",
         "name":"Irish File News"
      }
   ],
   "summary":"The man who murdered Karen Buckley by hitting her at least 12 times with a spanner before hiding her body in a barrel of chemicals has been branded \"truly evil\" by the Irish student's father.",
   "edNote":"Stills and video available",
   "meta":{
      "pageCount":"1"
   }
}

The keys presented in the summary response are similar to those in the Full Asset Response (see below), excluding content and providing only the first picture in the media list.

Full Asset Response

The full asset response is used when a specific asset is retrieved by ID from the /assets/{asset_id} endpoint.

{
    "kind": "asset",
    "id": "7e1f59bd-635f-4e25-97ca-408a4edf6395",
    "story": {
        "id": "38e87898-fbda-41fc-aa04-4365c9258070",
        "media": [{
            "kind": "picture",
            "id": "2.23320122",
            "title": "Jobless figure expected to fall",
            "summary": "Some regions fare better than others in the new unemployment figures",
            "credit": "PA WIRE",
            "renditions": {
                "thumb": {
                    "width": 127,
                    "height": 81,
                    "size": 4377,
                    "href": "https://news.static.press.net/v2/image/thumbnail/f0d427b5a1cc2c2a911ad95592c463ff/2.23320122.jpg"
                },
                "preview": {
                    "width": 511,
                    "height": 325,
                    "size": 37791,
                    "href": "https://news.static.press.net/v2/image/preview/8db1b5a848c824749459c219a9fdf436/2.23320122.jpg"
                },
                "full": {
                    "width": 2813,
                    "height": 1790,
                    "size": 492197,
                    "href": "https://news.static.press.net/v2/image/production/501ceac342642bcc25982224f616c98b/2.23320122.jpg"
                }
            },
        {
            "kind": "social-collection",
            "href": "http://social.api.press.net/v1/collections/urn:newsapi:storychain:680353ba-6535-42f2-92db-12989f17e015"        
        }],
        "meta": {
            "pictureCount": "1",
            "videoCount": "0",
            "sidebarCount": "0",
            "leadCount": "1",
            "curatedSocialAttached": "true"
        },
        "parent": {
            "id": "d529f6d3-bd18-4372-984d-0b9a0d31ee06"
        }
    },
    "leadNumber": 0,
    "title": "INDUSTRY Unemployment Regions",
    "headline": "Breakdown of regional unemployment figures",
    "updated": "2015-08-12T08:55:31.432Z",
    "tags": [{
        "id": "pakeyword:unemployment",
        "kind": "keyword",
        "name": "Unemployment"
    }, {
        "id": "pakeyword:regions",
        "kind": "keyword",
        "name": "Regions"
    }, {
        "id": "tag:unemployment-rate",
        "kind": "simple-tag",
        "name": "unemployment rate"
    }, {
        "id": "tag:regions-of-england",
        "kind": "simple-tag",
        "name": "Regions of England"
    }, {
        "id": "tag:wales",
        "kind": "simple-tag",
        "name": "Wales"
    }, {
        "id": "tag:scotland",
        "kind": "simple-tag",
        "name": "Scotland"
    }, {
        "id": "tag:northern-ireland",
        "kind": "simple-tag",
        "name": "Northern Ireland"
    }, {
        "id": "tag:unemployment",
        "kind": "simple-tag",
        "name": "Unemployment"
    }, {
        "id": "patopic:INDUSTRY",
        "kind": "wire-topic",
        "name": "Industry"
    }, {
        "id": "patopic:POLITICS",
        "kind": "wire-topic",
        "name": "Politics"
    }, {
        "id": "pacategory:HHH",
        "kind": "category",
        "name": "Home News"
    }, {
        "id": "pacategory:SCN",
        "kind": "category",
        "name": "Scottish News"
    }, {
        "id": "pacategory:PPW",
        "kind": "category",
        "name": "Welsh Parliament"
    }, {
        "id": "pacategory:PPI",
        "kind": "category",
        "name": "Irish Parliament"
    }],
    "summary": "Figures showing regional unemployment between April and June (region, total unemployed, change on quarter and unemployment rate)",
    "meta": {
        "pageCount": "1"
    },
    "content": "<article><section data-page-number="\&quot;1\&quot;" data-page-modified="\&quot;2015-08-12T08:55:31Z\&quot;"><p>Figures showing regional unemployment between April and June (region, total unemployed, change on quarter and unemployment rate)</p><p>North East 103,000 plus 7,000 8.1%</p><p>North West 213,000 plus 11,000 6.0%</p><p>Yorkshire and The Humber 174,000 minus 3,000 6.5%</p><p>East Midlands 112,000 minus 3,000 4.7%</p><p>West Midlands 167,000 minus 12,000 6.0%</p><p>East of England 146,000 plus 9,000 4.7%</p><p>London 307,000 plus 22,000 6.7%</p><p>South East 207,000 plus 11,000 4.5%</p><p>South West 124,000 plus 5,000 4.4%</p><p>Wales 90,000 minus 9,000 5.9%</p><p>Scotland 155,000 minus 13,000 5.6%</p><p>Northern Ireland 56,000 plus 1,000 6.5%</p></section></article>"
}

The keys have the following usage:

KeyRequired?Usage
kind mandatory Specifies the type of asset. Usually asset by could be snap or advisory
id mandatory The unique identifier for the asset
story optional Where an asset belongs to an overall story, which may involve a sequence of asset leads that replace each other - then the story section can be used to identify this and other data shared by all those assets, such as media. Will not exist for snaps. 
leadNumber optional This asset's position in the sequence of leads for the story, starting from 0 for the original.
title mandatory A PA moniker for the asset, intended for editorial use but not for display to consumers.
headline mandatory the headline for the asset
updated mandatory The date and time of the last published update to this asset
tags mandatory The set of classification and entity metadata tagged against the asset. Each tag has an id, which can be used in a ?tag={tag_id} search query, and a name which is intended for display use for that tag. Tags may also have a kind to help disambiguate their nature, such as keyword
summary mandatory A short abstract/description of the asset. Commonly this is the first paragraph of the asset (PA's intros are written to be stand-alone in this way) unless a specific abstract has been written.
edNote optional Contain any notes or remarks from PA editorial on this asset
meta mandatory The meta section contain convenient info on the asset, such as the current number of pages in pageCount
content mandatory The body content of the story, encoded as an HTML5 article
story.id mandatory The unique identifier of the story that this asset belongs to, which will be the same for all assets that are leads
story.media mandatory Related pictures and videos for the story. The media array will always be present (but empty), even if the story has no attached pictures or videos.
story.media.kind mandatory The type of media asset - either picture, video or social-collection. Note that videos only have an id which matches the ID used to upload the video content directly to the client's CDN. Videos are not available for access via the News API. The social-collection kind is used to provide a link to a curated collection of social links in the Social API
story.media.id mandatory A unique identifier for the media object
story.media.title mandatory The title or headline of the media object
story.media.summary mandatory A caption for use with the media object
story.media.renditions mandatory Pictures can have multiple renditions - fullpreview and thumbnail. Each rendition includes dimensions, file size, and a download link as href.
story.media.href mandatory When the kind is social-collection, the href key provides a link to the curated social collection for this story in the Social API
story.meta mandatory Convenient information regarding the story this asset is part of, including the count of pictures, videos, sidebars, leads. Also there is a flag, curatedSocialAttached, to indicate if there is a linked social collection the the Social API 

Story response

The story response is returned when accessing the /stories/{story_id} endpoint. Story ids are revealed in the story section of assets. For example:

{
    "kind": "story",
    "id": "479dc90c-63c5-4076-9fc3-7b1d4e1f2c6a",
    "title": "INDUSTRY Strike",
    "updated": "2014-07-10T21:03:29.112Z",
    "leads": [{
        "kind": "asset",
        "id": "f2f857e8-1ce4-4997-86ca-10a4382dd00d",
        "leadNumber": 4,
        "title": "INDUSTRY Strike",
        "headline": "Unions 'overwhelmed' by support",
        "updated": "2014-07-10T15:34:58.152Z",
        "tags": [{
            "id": "pakeyword:strike",
            "kind": "keyword",
            "name": "Strike"
        }, {
            "id": "patopic:INDUSTRY",
            "kind": "wire-topic",
            "name": "Industry"
        }, {
            "id": "patopic:POLITICS",
            "kind": "wire-topic",
            "name": "Politics"
        }, {
            "id": "patopic:EDUCATION",
            "kind": "wire-topic",
            "name": "Education"
        }, {
            "id": "pacategory:HHH",
            "kind": "category",
            "name": "Home News"
        }, {
            "id": "pacategory:PPW",
            "kind": "category",
            "name": "Welsh Parliament"
        }],
        "summary": "Union leaders have warned the government that industrial action will continue into next year after a strike by over a million public sector workers caused widespread disruption to schools, councils and the fire service.",
        "meta": {
            "pageCount": "1"
        }
    }],
    "media": [{
        "kind": "picture",
        "id": "2.20360036",
        "title": "Public sector strike",
        "summary": "Public sector workers marched through Newcastle city centre as part of the one-day walkout ",
        "credit": "PA WIRE",
        "renditions": {
            "thumb": {
                "width": 127,
                "height": 84,
                "size": 7999,
                "href": "https://news.static.press.net/v2/image/thumbnail/97c79ce5a33be45d48bfadbb428e11b6/2.20360036.jpg"
            },
            "preview": {
                "width": 511,
                "height": 340,
                "size": 98295,
                "href": "https://news.static.press.net/v2/image/preview/2656b3c8b05f809a223a82caa9e047c3/2.20360036.jpg"
            },
            "full": {
                "width": 4252,
                "height": 2830,
                "size": 2210113,
                "href": "https://news.static.press.net/v2/image/production/318b0438136563e83e2200ee67e6c11b/2.20360036.jpg"
            }
        }
    }, {
        "kind": "video",
        "id": "urn:newsml:pressassociation.com:20140710:Ikes1405015717096I"
    }],
    "meta": {
        "pictureCount": "1",
        "videoCount": "1",
        "sidebarCount": "6",
        "leadCount": "5",
        "curatedSocialAttached": "false"
    }
}

The response contains information that belongs to the overall story that groups a sequence of asset leads together. The kind key is story, with the id being the story id (as seen in the asset story section). The updated value is a general update time for the story, such as when the media was last updated or a new lead added.

The leads key is an array that provides the most recently published lead for the story. It contain a further reduced summary of the asset, that does not contain the media (since this is provided elsewhere in the story reponse). A list of all the leads for the story can be discovered by calling the /stories/{story_id}/leads endpoint.

The media key provides an array of media that belongs to the story and all of it's assets. The list is shared by all the asset leads. The media section can also be used to discover if a curated social collection has been associated with this story in the Social API.

The meta key provides convenient information on the story, such as counts for the pictures, videos, sidebars, leads and present of a linked social collection.

Gallery response

The gallery response is returned by the /galleries/{gallery_id} endpoint and is a specialised media asset containing a set of curated pictures on a theme. The response looks like:

{
    "kind": "gallery",
    "id": "week-in-photos",
    "title": "Week In Photos",
    "headline": "August 1 week - in pictures",
    "updated": "2015-08-07T06:38:11.081Z",
    "media": [{
        "kind": "picture",
        "id": "2.23745873",
        "title": "Summer weather August 6, 2015",
        "summary": "A beautiful start to the day as the sun rises behind St Mary's Lighthouse near Whitley Bay on Tyneside. (PA)",
        "credit": "PA WIRE",
        "renditions": {
            "thumb": {
                "width": 127,
                "height": 81,
                "size": 3903,
                "href": "https://news.static.press.net/v2/image/thumbnail/c09cca56484ae055fb063d0ecb0069d6/2.23745873.jpg"
            },
            "preview": {
                "width": 512,
                "height": 328,
                "size": 34325,
                "href": "https://news.static.press.net/v2/image/preview/2dea1e0d4e7e46660aba8f27343e995c/2.23745873.jpg"
            },
            "full": {
                "width": 3500,
                "height": 2243,
                "size": 1054603,
                "href": "https://news.static.press.net/v2/image/production/ed00a1832340edcf0ba237dde3fe648d/2.23745873.jpg"
            }
        }
    },
    ... 
    ],
    "meta": {
        "pictureCount": "10",
        "videoCount": "0"
    }
}

This response has a kind of gallery, the id is the gallery id, the title is the gallery label and the headline is the current headline for gallery (so will change). The updated value is the publish time of the gallery.

Otherwise there is a media array that works exactly the same as in asset and story objects, which is used to convey the pictures in the gallery. The meta section is there to provide a convenient count of pictures and video.

Docs Navigation