GET /articles/{id}
1 min
GET
https://api.cmp.optimizely.com/v3/articles/{id}
Path Parameters
- idstringrequiredExampleDescription
Responses
200
- LibraryArticle
- idstringrequiredExampleDescription
- titlestringrequiredExampleDescription
- created_atstring<date-time>requiredExampleDescriptionFormatdate-time
- modified_atstring<date-time>requiredExampleDescriptionFormatdate-time
- html_bodystringrequiredExampleDescription
- folder_idstringrequiredExampleDescription
- file_locationstringrequiredExampleDescription
- is_archivedbooleanrequiredDescription
- labelsResourceLabelResponse[]requiredDescription
- groupobjectrequiredDescription
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- valuesobject[]requiredDescription
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- group_idstringrequiredExampleDescription
- meta_titlestringrequiredExampleDescription
- meta_descriptionstringrequiredExampleDescription
- meta_urlstringrequiredExampleDescription
- meta_keywordsstring[]requiredExample
[ "key", "word", "keyword" ]
Description - source_articlestringrequiredExampleDescription
- source_namestringrequiredExampleDescription
- urlstringrequiredExampleDescription
- authorsArticleAuthorResponse[]requiredDescription
- namestringrequiredExampleDescription
- lang_codestringrequiredExampleDescription
- pixel_keystringrequiredExampleDescription
- imagesFeaturedImageResponse[]requiredDescription
- attribution_textstringrequiredExampleDescription
- captionstringrequiredExampleDescription
- descriptionstringrequiredExampleDescription
- mime_typestringrequiredExampleDescription
- sourceobjectrequiredDescription
- namestringrequiredExampleDescription
- urlstringrequiredExampleDescription
- heightintegerrequiredExampleDescription
- widthintegerrequiredExampleDescription
- thumbnailstringrequiredExampleDescription
- owner_organization_idstringrequiredExampleDescription
- expires_atstring<date-time>requiredExampleDescriptionFormatdate-time
- thumbnail_urlstringrequiredExampleDescription
- version_numberintegerrequiredExampleDescription
- version_idstringrequiredExampleDescription
- tagsTag[]requiredDescription
- guidstringrequiredExampleDescription
- namestringrequiredExampleDescription
- owner_idstringrequiredExampleDescription
400
- ErrorExample
{ "message": "Unsupported arguments: a,b,c" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
401
- ErrorExample
{ "message": "Unauthorized" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
403
- ErrorExample
{ "message": "You do not have the permission to perform this operation" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
404
- ErrorExample
{ "message": "Resource not found" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
curl
curl --request GET \
--url https://api.cmp.optimizely.com/v3/articles/{id} \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.cmp.optimizely.com/v3/articles/{id}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.cmp.optimizely.com/v3/articles/{id}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.cmp.optimizely.com/v3/articles/{id}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Fetched article
{
"id": "5d7f910551b00a722e0418830cee6631",
"title": "3 Ways Influencer Marketing Will Further Mature in 2020",
"created_at": "2019-10-06T13:15:30Z",
"modified_at": "2019-10-07T13:15:30Z",
"html_body": "<p>Article text</p>",
"folder_id": "6bb8db20a5b611ebae319b7c541b1a5a",
"file_location": "/all assets/",
"is_archived": false,
"labels": [
{
"group": {
"id": "2467e583a60e23fda2b89db81a453cd2",
"name": "Content Format"
},
"values": [
{
"id": "71c378f3fee3d822759d1bdc2aab628c",
"name": "Photos"
}
]
}
],
"group_id": "7949c82ce3ae11eba378dbacdf18f20c",
"meta_title": "3 Ways Influencer Marketing Will Further Mature in 2020",
"meta_description": "Article text",
"meta_url": "/",
"meta_keywords": [
""
],
"source_article": "https://source-vendor.com/sample-article",
"source_name": "Optimizely CMP",
"url": "https://example.com/sample-article",
"authors": [
{
"name": "John Doe"
}
],
"lang_code": "eng",
"pixel_key": "https://pixel.cmp.optimizely.com/px.gif?key=YXJ0aWNsZT0zZmJjN2Y5NmUzYzcxMWViOGVmNTAyNDJhYzEyMDAxOA==",
"images": [
{
"attribution_text": "This is a sample attribution text",
"caption": "This is a sample caption",
"description": "This is a sample description",
"mime_type": "image/jpeg",
"source": {
"name": "Reuters"
},
"url": "https://images-cdn.cmp.optimizely.com/sample.jpeg",
"height": 400,
"width": 700,
"thumbnail": "https://images-cdn.cmp.optimizely.com/Zz01Y2FkOWFjZWQ5OTMxMWViYjY3OTEzNDMzOWM3ZDNhNA==?width=75&height=75"
}
],
"owner_organization_id": "5108c3a9becac35915111191",
"expires_at": "2019-10-07T13:15:30Z",
"thumbnail_url": "http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==",
"version_number": 2,
"version_id": "5d7f910551b00a722e0418830cee6631",
"tags": [
{
"guid": "5d7f910551b00a722e0418830cee6633",
"name": "Sample Tag"
}
],
"owner_id": "5108c3a9becac35915111191"
}400
// Client error
{
"message": "Not found",
"errors": ""
}401
// Authorization error
{
"message": "Not found",
"errors": ""
}403
// Permission error
{
"message": "Not found",
"errors": ""
}404
// Not found error
{
"message": "Not found",
"errors": ""
}