Model: LibraryArticle

1 min

Model Parameters

LibraryArticle
- idstringrequired
  Example
  5d7f910551b00a722e0418830cee6631
  Description
  Unique identifier of the article
- titlestringrequired
  Example
  3 Ways Influencer Marketing Will Further Mature in 2020
  Description
  Title of the article
- created_atstring<date-time>required
  Example
  2019-10-06T13:15:30Z
  Description
  Date and time on which the article was created, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- modified_atstring<date-time>required
  Example
  2019-10-07T13:15:30Z
  Description
  Date and time of the most recent modification of the article, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- html_bodystringrequired
  Example
  Article text
  Description
  Content of the article
- folder_idstringrequired
  Example
  6bb8db20a5b611ebae319b7c541b1a5a
  Description
  ID of the folder containing the article in the library
- file_locationstringrequired
  Example
  /all assets/
  Description
  Location of the folder containing the article in the library
- is_archivedbooleanrequired
  Description
  Whether the article is archived or not
- labelsResourceLabelResponse[]required
  Description
  Labels associated with the article
  - groupobjectrequired
    Description
    Label group
    - idstringrequired
      Example
      2467e583a60e23fda2b89db81a453cd2
      Description
      Identifier of the label group
    - namestringrequired
      Example
      Content Format
      Description
      Name of the label group
  - valuesobject[]required
    Description
    List of values of the label
    - idstringrequired
      Example
      71c378f3fee3d822759d1bdc2aab628c
      Description
      Identifier of the label value
    - namestringrequired
      Example
      Photos
      Description
      Name of the label value
- group_idstringrequired
  Example
  7949c82ce3ae11eba378dbacdf18f20c
  Description
  Unique identifier of the source article in case of copied or translated articles
- meta_titlestringrequired
  Example
  3 Ways Influencer Marketing Will Further Mature in 2020
  Description
  Meta title of the article
- meta_descriptionstringrequired
  Example
  Article text
  Description
  Meta description of the article
- meta_urlstringrequired
  Example
  /
  Description
  Meta URL of the article
- meta_keywordsstring[]required
  Example
```
[
  "key",
  "word",
  "keyword"
]
```
  Description
  Meta Keywords of the article
- source_articlestringrequired
  Example
  https://source-vendor.com/sample-article
  Description
  Link to the vendor article for Marketplace article or Task article ID for created article
- source_namestringrequired
  Example
  Optimizely CMP
  Description
  Name of the article's source
- urlstringrequired
  Example
  https://example.com/sample-article
  Description
  Link to the published article
- authorsArticleAuthorResponse[]required
  Description
  List of authors of the article
  - namestringrequired
    Example
    John Doe
    Description
    Name of Author
- lang_codestringrequired
  Example
  eng
  Description
  Language code depicting the language of the article
- pixel_keystringrequired
  Example
  https://pixel.cmp.optimizely.com/px.gif?key=YXJ0aWNsZT0zZmJjN2Y5NmUzYzcxMWViOGVmNTAyNDJhYzEyMDAxOA==
  Description
  Unique tracking pixel of the article
- imagesFeaturedImageResponse[]required
  Description
  Featured images of the article
  - attribution_textstringrequired
    Example
    This is a sample attribution text
    Description
    Attribution text of the featured image
  - captionstringrequired
    Example
    This is a sample caption
    Description
    Caption of the featured image
  - descriptionstringrequired
    Example
    This is a sample description
    Description
    Description of the featured image
  - mime_typestringrequired
    Example
    image/jpeg
    Description
    MIME type of the featured image
  - sourceobjectrequired
    Description
    Source of the featured image
    - namestringrequired
      Example
      Reuters
      Description
      Organization or vendor name of the featured image
  - urlstringrequired
    Example
    https://images-cdn.cmp.optimizely.com/sample.jpeg
    Description
    URL of the featured image
  - heightintegerrequired
    Example
    400
    Description
    Height of the featured image in pixels
  - widthintegerrequired
    Example
    700
    Description
    Width of the featured image in pixels
  - thumbnailstringrequired
    Example
    https://images-cdn.cmp.optimizely.com/Zz01Y2FkOWFjZWQ5OTMxMWViYjY3OTEzNDMzOWM3ZDNhNA==?width=75&height=75
    Description
    URL of the featured image thumbnail
- owner_organization_idstringrequired
  Example
  5108c3a9becac35915111191
  Description
  ID of owner organization of the article
- expires_atstring<date-time>required
  Example
  2019-10-07T13:15:30Z
  Description
  Date and time for the expiration of the article, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- thumbnail_urlstringrequired
  Example
  http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==
  Description
  URL of the thumbnail of the article
- version_numberintegerrequired
  Example
  2
  Description
  Version number of article
- version_idstringrequired
  Example
  5d7f910551b00a722e0418830cee6631
  Description
  Version id of article
- tagsTag[]required
  Description
  Tags for the article
  - guidstringrequired
    Example
    5d7f910551b00a722e0418830cee6633
    Description
    Unique identifier of the tag
  - namestringrequired
    Example
    Sample Tag
    Description
    Name of the tag
- owner_idstringrequired
  Example
  5108c3a9becac35915111191
  Description
  ID of the article owner