API Documentation

casmir72 edited this page Sep 21, 2016 · 2 revisions

In version 4.1 of PressForward we introduced the inclusion of PressForward metadata on the WP REST API post endpoint. As we continue to develop the PressForward API we will update this documentation. Below is a list of all the information currently available on the Post endpoint for a post that was drafted through PressForward. Currently, only data about published posts is available.

If you are unfamiliar with the WP API or how to access it, be sure to view the documentation for the API.

PressForward Meta Data available for a Post Object:

Item Date: Date posted on the original site. Appears on the item, nomination, and post level.

Item Author: Author(s) listed on the original site. Appears on the item, nomination, and post level.

Item Link: Source link. Appears on the item, nomination, and post level.

Item Feat Img: A featured image associated with the item, when it is available. Appears on the item, nomination, and post level.

Item ID: A unique PressForward ID. Stores hashed ID based on the title and url of retrieved item. Appears on the item, nomination, and post level.

Item_wp_date: The datetime an item was added to WordPress via PressForward.Appears on the item, nomination, and post level.

Source Repeats: Counts number of times the item has been collected from the multiple feeds (Ex: from origin feed and Twitter). Appears on the item, nomination, and post level.

Readable Status: A check to determine if the content of the item has been made readable. Appears on the item, nomination, and post level.

Item Tags: An array of tags associated with the item, as created in the feed. Appears on the item, nomination, and post level.

Wordcount: Stores the count of the original words retrieved with the feed item. Appears on the item, nomination, and post level.

Feed: link to endpoint for the feed the post was retrieved for.