contentsholder/posts.list
Retrieves a list of Stories in your Content Owner Media Unit
URL
GET /v1.0/contentsholder/posts.list
Parameters
| Argument | Required | Default Value | Example | Description |
|---|---|---|---|---|
| unit_id | Required | - | 12345678912345 | ID of your Content Owner Media Unit |
| label | Optional | Null | Weather | Filter Stories by label(s). Specifies the label(s) a Story should contain. If the argument’s value is null, Stories will not be filtered for specific labels. |
| series_id | Optional | Null | 5678901 | Filter Stories by series. Specifies the ID of the series associated with a Story. If the argument’s is null, Stories will not be filtered for specific series. |
| topic_id | Optional | Null | 56794038 | Filter Stories by topic. Specifies the ID of the topic associated with a Story. If the argument’s value is null, Stories will not be filtered for specific topics. |
| status | Optional | Null | Draft | Filter Stories by publication status. Specifies the publication status associated with a Story i.e.“Draft” and “Public”. If the argument’s value is null, Stories will not be filtered for a specific status. |
| published | Optional | Null | True | Filter Stories by published date. Set this to “True” to retrieve Stories after the published date. When it is set to “False”, it will retrieve the Stories before the published date. If the argument’s value is null, Stories will not be filtered for published date. |
| expired | Optional | Null | True | Filter Stories by expiry date. Set this to “True” to retrieve expired Stories. When it is set to “False”, it will retrieve Stories that are yet to expire. If the argument’s value is null,, Stories will not be filtered for expiry dates. |
| offset | Optional | 0 | 0 | Defines the start position for retrieving items. Use a number between 0 to 5000 for this argument. |
| limit | Optional | 10 | 10 | The argument indicates the maximum number of items to retrieve. Use a number between 1 to 100 for this argument. |
| sort | Optional | created_at | created_at | Describes the sorting order. To sort by the date the Story was created use the value “created_at”. To sort by the publishing date, use the value ”published_at”. |
Responses
{
"ok": true,
"posts": [
{
"id": "0123456",
"url": "https://nordot.app/0123456",
"title": "Counting down to sakura blooming",
"subtitle": "",
"status": "public",
"description": "Blooming forecasted this weekend",
"source_url": "",
"published_at": "2017-12-21T02:05:31+00:00",
"expired_at": "9999-12-31T23:59:59+00:00",
"created_at": "2017-12-21T02:05:32+00:00",
"updated_at": "2018-02-06T20:17:23+00:00",
"cover_image": "https://nordot-res.cloudinary.com/t_size_l/ch/images/0123456/origin_1.jpg",
"images":[
{
"id": "0123456",
"filename": "0123456.JPG",
"url": "https://nordot-res.cloudinary.com/t_size_l/ch/images/0123456/origin_1.jpg",
"url_w": 800,
"url_h": 1200,
"thumb_360": "https://nordot-res.cloudinary.com/t_thumb_360/ch/images/0123456/origin_1.jpg",
"caption": "",
"created_at": "2017-11-25T01:42:18+00:00",
"updated_at": "2017-11-25T01:42:18+00:00"
},
...
],
"labels":[
{
"name": "sakura",
"count": 5
},
],
"tags": [
"weather",
"weatherreport"
],
"series":{
"id": "0123455",
"title": "series2",
"description": "",
"created_at": "2017-02-07T09:30:59+00:00",
"updated_at": "2017-05-16T05:57:26+00:00",
"cover_image":{
"url": "https://nordot-res.cloudinary.com/ch/series/0123455/cover_2.jpg",
"thumb_360": "https://nordot-res.cloudinary.com/t_thumb_360/ch/series/0123455/cover_2.jpg"
}
},
"topic":{
"id": "201631389440476662",
"title": "Topic1",
"created_at": "2017-02-07T09:31:09+00:00",
"updated_at": "2017-02-07T09:31:09+00:00"
},
"creator": null,
"updater":{
"id": "0012344",
"email": "nordots@xxx.jp",
"name": "Taro",
"job_title": "writer",
"about": "Predicting cherry blossoms for 30 years",
"accepted_terms_ver": 1,
"created_at": "2015-11-17T11:33:40+00:00",
"updated_at": "2018-02-20T11:36:14+00:00",
"profile_image":{
"url": "https://nordot-res.cloudinary.com/members/0012344/profile_1.png",
"thumb_360": "https://nordot-res.cloudinary.com/t_thumb_360/members/0012344/profile_1.png"
}
},
"authors":[
],
"unit":{
"id": "1234567",
"name": "Nordot Post",
"status": "public",
"signature_color": "0f0f0f",
"header_type": "background",
"header_position": "center",
"copyright_owner": "Nordot Inc.",
"default_post_expire_days": 0,
"created_at": "2015-11-16T19:06:46+00:00",
"updated_at": "2018-03-05T03:17:04+00:00",
"header_image":{
"url": "https://nordot-res.cloudinary.com/ch/units/1234567/header_69.png",
"url_w": 400,
},
"profile_image": null,
"publisher":{
"id": "0012345",
"name": "Nordot Post",
"created_at":
"2015-11-16T19:02:38+00:00",
},
"language": "en-US",
"timezone": "Asia/Tokyo"
}
}
],
"paging":{
"count": 10,
"offset": 0,
"limit": 10,
"has_next": true
}
}
}If successful, the method returns an array list of “contentsholder post” object that meets the specified criteria. For more details, please refer to the “paging” and “contentsholder post” objects.
Errors
| Error Code | Description |
|---|---|
| no_unit_id | Value for "unit_id" is not specified. |
| invalid_unit_id | Value passed for "unit_id" is invalid. |
| unit_not_found | The Media Unit cannot be found. |
| invalid_label | Value passed for "label" is invalid. |
| invalid_series_id | Value passed for "series_id " is invalid. |
| series_not_found | The series cannot be found. |
| invalid_topic_id | Value passed for “topic_id " is invalid. |
| topic_not_found | The topic cannot be found. |
| invalid_status | Value passed for “status" is invalid. |
| invalid_published | Value passed for “published” is invalid. |
| invalid_expired | Value passed for “expired” is invalid. |
| invalid_offset | Value passed for “offset" is invalid. |
| invalid_limit | Value passed for “limit" is invalid. |
| invalid_sort | Value passed for “sort" is invalid. |
For other error codes, refer to the Common Errors section of this document.